# api.clarify.io API

> api.clarify.io API on Apizie: 21 endpoints (List bundles, Create a bundle, Get a bundle, Update a bundle, …) returned as clean JSON through one API key. 21 endpoints are live now. Call it over REST at https://apizie.tech/v1/search-tools:clarify/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `search-tools:clarify`
- Category: Search Tools
- Status: live
- Source: https://clarify.io
- Page: https://apizie.tech/api/search-tools/clarify
- OpenAPI: https://apizie.tech/api/search-tools/clarify/openapi.json

The API to Search and Understand Audio & Video Data.

## Endpoints

### List bundles
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | limit results to specified number of bundles. Default is 10. Max 100. |
| embed | string | no | list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma… |
| iterator | string | no | optional opaque value, automatically provided in next/prev links, or literal "first", "last" |

### Create a bundle
`POST https://apizie.tech/v1/search-tools:clarify/post-v1-bundles`

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get a bundle
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles-bundle-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| embed | string | no | list of link relations to embed in the result bundle. Zero or more of: tracks, metadata, insights. List is space or comma separated single… |

### Update a bundle
`POST https://apizie.tech/v1/search-tools:clarify/put-v1-bundles-bundle-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| body | object | no | Form fields as a JSON object |

### Delete a bundle
`POST https://apizie.tech/v1/search-tools:clarify/delete-v1-bundles-bundle-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Get bundle insights
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles-bundle-id-insights`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Request an insight to be run
`POST https://apizie.tech/v1/search-tools:clarify/post-v1-bundles-bundle-id-insights`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| body | object | yes | Form fields as a JSON object |

### Get bundle insight
`GET https://apizie.tech/v1/search-tools:clarify/v1bundlesbundle-idinsightsinsight-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| insight_id | string | yes | id of an insight |

### Get bundle metadata
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles-bundle-id-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Update bundle metadata
`POST https://apizie.tech/v1/search-tools:clarify/put-v1-bundles-bundle-id-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| body | object | yes | Form fields as a JSON object |

### Delete bundle metadata
`POST https://apizie.tech/v1/search-tools:clarify/delete-v1-bundles-bundle-id-metadata`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Get bundle tracks
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles-bundle-id-tracks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Add a track for a bundle
`POST https://apizie.tech/v1/search-tools:clarify/post-v1-bundles-bundle-id-tracks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| body | object | no | Form fields as a JSON object |

### Update a tracks for a bundle
`POST https://apizie.tech/v1/search-tools:clarify/put-v1-bundles-bundle-id-tracks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| body | object | yes | Form fields as a JSON object |

### Delete bundle tracks
`POST https://apizie.tech/v1/search-tools:clarify/delete-v1-bundles-bundle-id-tracks`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |

### Get bundle track
`GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles-bundle-id-tracks-track-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| track_id | string | yes | id of a track |

### Add media to a track
`POST https://apizie.tech/v1/search-tools:clarify/put-v1-bundles-bundle-id-tracks-track-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| track_id | string | yes | id of a track |
| body | object | yes | Form fields as a JSON object |

### Delete a bundle track
`POST https://apizie.tech/v1/search-tools:clarify/delete-v1-bundles-bundle-id-tracks-track-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| bundle_id | string | yes | id of a bundle |
| track_id | string | yes | id of a track |

### Generate Group Report beta
`GET https://apizie.tech/v1/search-tools:clarify/v1reportsscores`

| Parameter | Type | Required | Description |
|---|---|---|---|
| interval | string | yes | Duration of report periods. Default is month. |
| score_field | string | yes | A bundle/metadata field to use as a score. Ex. insights.spoken_words.listener_score. |
| group_field | string | yes | A metadata field by which to group scores, typically a user or team id field. |
| filter | string | no | filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters. |
| language | string | no | Language to search in, specified with an RFC5646 code. Default is "en" |

### Generate Trends Report beta
`GET https://apizie.tech/v1/search-tools:clarify/v1reportstrends`

| Parameter | Type | Required | Description |
|---|---|---|---|
| interval | string | yes | Duration of report periods. Default is month. |
| content | string | no | Content reported in each period. Zero or more of tracks, spoken_words, spoken_keywords. List is space or comma separated single string or… |
| filter | string | no | filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters. |
| language | string | no | Language to search in, specified with an RFC5646 code. Default is "en" |

### Search bundles
`GET https://apizie.tech/v1/search-tools:clarify/v1search`

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | no | search terms, typically as typed into a search field. Up to 120 characters. |
| query_fields | string | no | list of insights, metadata, and bundle fields to search with the query. Use insights.spoken_words for searching audio, metadata.* for all… |
| filter | string | no | filter expression, typically programmatically generated based on input controls and data segregation rules etc. Up to 500 characters. |
| language | string | no | Language to search in, specified with an RFC5646 code. Default is "en" |
| limit | integer | no | limit results to specified number of bundles. Default is 10. Max 100. |
| embed | string | no | list of link relations to embed in the result collection. Zero or more of: items, tracks, metadata, insights. List is space or comma… |
| iterator | string | no | opaque value, automatically provided in next/prev links |

## Example
```
curl "https://apizie.tech/v1/search-tools:clarify/get-v1-bundles" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the api.clarify.io API?
Create a free Apizie key, then send GET https://apizie.tech/v1/search-tools:clarify/get-v1-bundles with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the api.clarify.io API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the api.clarify.io API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key search-tools:clarify.

### What is the status of the api.clarify.io API?
Live: works with just an Apizie key