{"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/search-tools:clarify/get-v1-bundles":{"get":{"operationId":"search_tools_clarify_get_v1_bundles","summary":"List bundles","description":"GET /v1/bundles","tags":["search-tools"],"parameters":[{"name":"limit","in":"query","required":false,"description":"limit results to specified number of bundles. Default is 10. Max 100.","schema":{"type":"integer","description":"limit results to specified number of bundles. Default is 10. Max 100."}},{"name":"embed","in":"query","required":false,"description":"list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma…","schema":{"type":"string","description":"list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma…"}},{"name":"iterator","in":"query","required":false,"description":"optional opaque value, automatically provided in next/prev links, or literal \"first\", \"last\"","schema":{"type":"string","description":"optional opaque value, automatically provided in next/prev links, or literal \"first\", \"last\""}}],"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/search-tools:clarify/post-v1-bundles":{"post":{"operationId":"search_tools_clarify_post_v1_bundles","summary":"Create a bundle","description":"POST /v1/bundles","tags":["search-tools"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"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":"live"}},"/v1/search-tools:clarify/get-v1-bundles-bundle-id":{"get":{"operationId":"search_tools_clarify_get_v1_bundles_bundle_id","summary":"Get a bundle","description":"GET /v1/bundles/{bundle_id}","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}},{"name":"embed","in":"query","required":false,"description":"list of link relations to embed in the result bundle. Zero or more of: tracks, metadata, insights. List is space or comma separated single…","schema":{"type":"string","description":"list of link relations to embed in the result bundle. Zero or more of: tracks, metadata, insights. List is space or comma separated single…"}}],"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/search-tools:clarify/put-v1-bundles-bundle-id":{"post":{"operationId":"search_tools_clarify_put_v1_bundles_bundle_id","summary":"Update a bundle","description":"PUT /v1/bundles/{bundle_id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"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":"live"}},"/v1/search-tools:clarify/delete-v1-bundles-bundle-id":{"post":{"operationId":"search_tools_clarify_delete_v1_bundles_bundle_id","summary":"Delete a bundle","description":"DELETE /v1/bundles/{bundle_id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"}}}}}},"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/search-tools:clarify/get-v1-bundles-bundle-id-insights":{"get":{"operationId":"search_tools_clarify_get_v1_bundles_bundle_id_insights","summary":"Get bundle insights","description":"GET /v1/bundles/{bundle_id}/insights","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}}],"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/search-tools:clarify/post-v1-bundles-bundle-id-insights":{"post":{"operationId":"search_tools_clarify_post_v1_bundles_bundle_id_insights","summary":"Request an insight to be run","description":"POST /v1/bundles/{bundle_id}/insights","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id","body"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"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":"live"}},"/v1/search-tools:clarify/v1bundlesbundle-idinsightsinsight-id":{"get":{"operationId":"search_tools_clarify_v1bundlesbundle_idinsightsinsight_id","summary":"Get bundle insight","description":"GET /v1/bundles/{bundle_id}/insights/{insight_id}","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}},{"name":"insight_id","in":"query","required":true,"description":"id of an insight","schema":{"type":"string","description":"id of an insight"}}],"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/search-tools:clarify/get-v1-bundles-bundle-id-metadata":{"get":{"operationId":"search_tools_clarify_get_v1_bundles_bundle_id_metadata","summary":"Get bundle metadata","description":"GET /v1/bundles/{bundle_id}/metadata","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}}],"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/search-tools:clarify/put-v1-bundles-bundle-id-metadata":{"post":{"operationId":"search_tools_clarify_put_v1_bundles_bundle_id_metadata","summary":"Update bundle metadata","description":"PUT /v1/bundles/{bundle_id}/metadata","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id","body"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"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":"live"}},"/v1/search-tools:clarify/delete-v1-bundles-bundle-id-metadata":{"post":{"operationId":"search_tools_clarify_delete_v1_bundles_bundle_id_metadata","summary":"Delete bundle metadata","description":"DELETE /v1/bundles/{bundle_id}/metadata","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"}}}}}},"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/search-tools:clarify/get-v1-bundles-bundle-id-tracks":{"get":{"operationId":"search_tools_clarify_get_v1_bundles_bundle_id_tracks","summary":"Get bundle tracks","description":"GET /v1/bundles/{bundle_id}/tracks","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}}],"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/search-tools:clarify/post-v1-bundles-bundle-id-tracks":{"post":{"operationId":"search_tools_clarify_post_v1_bundles_bundle_id_tracks","summary":"Add a track for a bundle","description":"POST /v1/bundles/{bundle_id}/tracks","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"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":"live"}},"/v1/search-tools:clarify/put-v1-bundles-bundle-id-tracks":{"post":{"operationId":"search_tools_clarify_put_v1_bundles_bundle_id_tracks","summary":"Update a tracks for a bundle","description":"PUT /v1/bundles/{bundle_id}/tracks","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id","body"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"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":"live"}},"/v1/search-tools:clarify/delete-v1-bundles-bundle-id-tracks":{"post":{"operationId":"search_tools_clarify_delete_v1_bundles_bundle_id_tracks","summary":"Delete bundle tracks","description":"DELETE /v1/bundles/{bundle_id}/tracks","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"}}}}}},"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/search-tools:clarify/get-v1-bundles-bundle-id-tracks-track-id":{"get":{"operationId":"search_tools_clarify_get_v1_bundles_bundle_id_tracks_track_id","summary":"Get bundle track","description":"GET /v1/bundles/{bundle_id}/tracks/{track_id}","tags":["search-tools"],"parameters":[{"name":"bundle_id","in":"query","required":true,"description":"id of a bundle","schema":{"type":"string","description":"id of a bundle"}},{"name":"track_id","in":"query","required":true,"description":"id of a track","schema":{"type":"string","description":"id of a track"}}],"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/search-tools:clarify/put-v1-bundles-bundle-id-tracks-track-id":{"post":{"operationId":"search_tools_clarify_put_v1_bundles_bundle_id_tracks_track_id","summary":"Add media to a track","description":"PUT /v1/bundles/{bundle_id}/tracks/{track_id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id","track_id","body"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"track_id":{"type":"string","description":"id of a track"},"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":"live"}},"/v1/search-tools:clarify/delete-v1-bundles-bundle-id-tracks-track-id":{"post":{"operationId":"search_tools_clarify_delete_v1_bundles_bundle_id_tracks_track_id","summary":"Delete a bundle track","description":"DELETE /v1/bundles/{bundle_id}/tracks/{track_id}","tags":["search-tools"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["bundle_id","track_id"],"properties":{"bundle_id":{"type":"string","description":"id of a bundle"},"track_id":{"type":"string","description":"id of a track"}}}}}},"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/search-tools:clarify/v1reportsscores":{"get":{"operationId":"search_tools_clarify_v1reportsscores","summary":"Generate Group Report beta","description":"GET /v1/reports/scores","tags":["search-tools"],"parameters":[{"name":"interval","in":"query","required":true,"description":"Duration of report periods. Default is month.","schema":{"type":"string","enum":["year","quarter","month","week","day","hour"],"description":"Duration of report periods. Default is month."}},{"name":"score_field","in":"query","required":true,"description":"A bundle/metadata field to use as a score. Ex. insights.spoken_words.listener_score.","schema":{"type":"string","description":"A bundle/metadata field to use as a score. Ex. insights.spoken_words.listener_score."}},{"name":"group_field","in":"query","required":true,"description":"A metadata field by which to group scores, typically a user or team id field.","schema":{"type":"string","description":"A metadata field by which to group scores, typically a user or team id field."}},{"name":"filter","in":"query","required":false,"description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters.","schema":{"type":"string","description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters."}},{"name":"language","in":"query","required":false,"description":"Language to search in, specified with an RFC5646 code. Default is \"en\"","schema":{"type":"string","enum":["en","en-UK","en-US","es","fr"],"description":"Language to search in, specified with an RFC5646 code. Default is \"en\""}}],"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/search-tools:clarify/v1reportstrends":{"get":{"operationId":"search_tools_clarify_v1reportstrends","summary":"Generate Trends Report beta","description":"GET /v1/reports/trends","tags":["search-tools"],"parameters":[{"name":"interval","in":"query","required":true,"description":"Duration of report periods. Default is month.","schema":{"type":"string","enum":["year","quarter","month","week","day","hour"],"description":"Duration of report periods. Default is month."}},{"name":"content","in":"query","required":false,"description":"Content reported in each period. Zero or more of tracks, spoken_words, spoken_keywords. List is space or comma separated single string or…","schema":{"type":"string","description":"Content reported in each period. Zero or more of tracks, spoken_words, spoken_keywords. List is space or comma separated single string or…"}},{"name":"filter","in":"query","required":false,"description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters.","schema":{"type":"string","description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters."}},{"name":"language","in":"query","required":false,"description":"Language to search in, specified with an RFC5646 code. Default is \"en\"","schema":{"type":"string","enum":["en","en-UK","en-US","es","fr"],"description":"Language to search in, specified with an RFC5646 code. Default is \"en\""}}],"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/search-tools:clarify/v1search":{"get":{"operationId":"search_tools_clarify_v1search","summary":"Search bundles","description":"GET /v1/search","tags":["search-tools"],"parameters":[{"name":"query","in":"query","required":false,"description":"search terms, typically as typed into a search field. Up to 120 characters.","schema":{"type":"string","description":"search terms, typically as typed into a search field. Up to 120 characters."}},{"name":"query_fields","in":"query","required":false,"description":"list of insights, metadata, and bundle fields to search with the query. Use insights.spoken_words for searching audio, metadata.* for all…","schema":{"type":"string","description":"list of insights, metadata, and bundle fields to search with the query. Use insights.spoken_words for searching audio, metadata.* for all…"}},{"name":"filter","in":"query","required":false,"description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters.","schema":{"type":"string","description":"filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters."}},{"name":"language","in":"query","required":false,"description":"Language to search in, specified with an RFC5646 code. Default is \"en\"","schema":{"type":"string","enum":["en","en-UK","en-US","es","fr"],"description":"Language to search in, specified with an RFC5646 code. Default is \"en\""}},{"name":"limit","in":"query","required":false,"description":"limit results to specified number of bundles. Default is 10. Max 100.","schema":{"type":"integer","description":"limit results to specified number of bundles. Default is 10. Max 100."}},{"name":"embed","in":"query","required":false,"description":"list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma…","schema":{"type":"string","description":"list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma…"}},{"name":"iterator","in":"query","required":false,"description":"opaque value, automatically provided in next/prev links","schema":{"type":"string","description":"opaque value, automatically provided in next/prev links"}}],"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"}}},"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"}}}}}}}