# Haystack API

## Docs

- [Log Search Result Click](https://developer.thehaystack.ai/api-reference/endpoints/analytics-click.md): Track when a user clicks a search result
- [Log Media Playback Event](https://developer.thehaystack.ai/api-reference/endpoints/analytics-media-playback.md): Record a play/pause/seek/progress/end event for a media asset. Used by the embed player.
- [Log Page View](https://developer.thehaystack.ai/api-reference/endpoints/analytics-page-view.md): Record a frontend page view. Used by the embed/Connect frontend — most API consumers do not need to call this.
- [Create Chapter](https://developer.thehaystack.ai/api-reference/endpoints/chapters-create.md)
- [Delete Chapter](https://developer.thehaystack.ai/api-reference/endpoints/chapters-delete.md)
- [Get Chapter](https://developer.thehaystack.ai/api-reference/endpoints/chapters-get.md)
- [List Chapters](https://developer.thehaystack.ai/api-reference/endpoints/chapters-list.md)
- [Update Chapter](https://developer.thehaystack.ai/api-reference/endpoints/chapters-update.md)
- [Create Collection](https://developer.thehaystack.ai/api-reference/endpoints/collections-create.md): Create a new collection
- [Get Collection](https://developer.thehaystack.ai/api-reference/endpoints/collections-get.md): Retrieve a single collection by ID
- [List Collections](https://developer.thehaystack.ai/api-reference/endpoints/collections-list.md): Retrieve all collections for your account
- [Update Collection](https://developer.thehaystack.ai/api-reference/endpoints/collections-update.md): Update a collection's metadata.
- [Get Frontend Style](https://developer.thehaystack.ai/api-reference/endpoints/frontend-style.md): Return the frontend style configuration used by the embed/Connect surface.
- [Get Home Feed](https://developer.thehaystack.ai/api-reference/endpoints/home.md): Return a ready-to-render home feed (recent items, series with their items). Used to populate the default Haystack frontend.
- [Delete Item Artwork](https://developer.thehaystack.ai/api-reference/endpoints/items-artwork-delete.md): Remove artwork of a specific variant from an item.
- [Upload Item Artwork](https://developer.thehaystack.ai/api-reference/endpoints/items-artwork-upload.md): Upload artwork for an item as multipart/form-data. Supports four variants: `square`, `wide`, `ultraWide`, `vertical`. Max size 15 MB.
- [Create Item](https://developer.thehaystack.ai/api-reference/endpoints/items-create.md): Create a new content item
- [Delete Item](https://developer.thehaystack.ai/api-reference/endpoints/items-delete.md): Permanently delete an item and all its related media assets, resources, scriptures, and analytics events.
- [Get Item](https://developer.thehaystack.ai/api-reference/endpoints/items-get.md): Retrieve a single item by ID
- [List Items](https://developer.thehaystack.ai/api-reference/endpoints/items-list.md): Retrieve content items with filtering and pagination
- [Publish Item](https://developer.thehaystack.ai/api-reference/endpoints/items-publish.md): Publish a ready item. No request body — the item must already be in `ready` or `unpublished` status with an indexed media asset.
- [List Similar Items](https://developer.thehaystack.ai/api-reference/endpoints/items-similar.md): Return items semantically similar to this one, ranked by vector similarity. Useful for "Related sermons" modules.
- [Get Item Transcript](https://developer.thehaystack.ai/api-reference/endpoints/items-transcript.md): Retrieve the full transcript for an item including semantic chunks. Requires the item to be processed.
- [Unpublish Item](https://developer.thehaystack.ai/api-reference/endpoints/items-unpublish.md): Take a published item offline. It remains in the library but is not discoverable via search or the public frontend.
- [Update Item](https://developer.thehaystack.ai/api-reference/endpoints/items-update.md): Update an existing item
- [Create Media Asset](https://developer.thehaystack.ai/api-reference/endpoints/media-create.md): Create a new media asset and receive an upload URL. Returns a secure upload URL where you can upload your video/audio file (max 5GB). If using YouTube or Vimeo for playback, provide externalPlatform and externalPlatformId, but you must still upload the original file to the returned uploadUrl for AI…
- [Delete Media Asset](https://developer.thehaystack.ai/api-reference/endpoints/media-delete.md): Delete a media asset and its underlying file. If it was the indexed asset and the item was published, the item is unpublished.
- [Get Media Asset](https://developer.thehaystack.ai/api-reference/endpoints/media-get.md): Retrieve media asset details including processing status
- [List Media Assets](https://developer.thehaystack.ai/api-reference/endpoints/media-list.md)
- [Update Media Asset](https://developer.thehaystack.ai/api-reference/endpoints/media-update.md): Update external platform link for a media asset. Only valid on video assets.
- [List Media Variant Types](https://developer.thehaystack.ai/api-reference/endpoints/media-variant-types.md): Retrieve all media variant types for your organization. Variant types define the different formats of media that can be uploaded (e.g., original video, sermon audio, full service).
- [List Resource Types](https://developer.thehaystack.ai/api-reference/endpoints/resource-types-list.md): List the resource type categories configured for your account. Use these to populate a picker when creating resources.
- [Create Resource](https://developer.thehaystack.ai/api-reference/endpoints/resources-create.md): Attach a file, external link, or external video to an item. For `file` resources, the response includes an `uploadUrl` — a presigned S3 URL that you must PUT the file to (with the same `Content-Type` as `fileMimeType`) to complete the upload. `link` and `video` resources have no upload step and retu…
- [Delete Resource](https://developer.thehaystack.ai/api-reference/endpoints/resources-delete.md): Delete a resource. For `file` resources, the underlying file is also removed from storage.
- [Get Resource](https://developer.thehaystack.ai/api-reference/endpoints/resources-get.md): Retrieve a single resource.
- [List Resources](https://developer.thehaystack.ai/api-reference/endpoints/resources-list.md): List all resources attached to an item.
- [Update Resource](https://developer.thehaystack.ai/api-reference/endpoints/resources-update.md): Update metadata for an existing resource. The `contentType` and underlying file cannot be changed once created — create a new resource if you need a different type.
- [Get Bible Metadata](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-bible-metadata.md): Return the canonical book list, chapter counts per book, and verse counts per chapter. Use to populate book/chapter/verse pickers.
- [Create Scripture](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-create.md)
- [Delete Scripture](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-delete.md)
- [Get Bible Text](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-full-text.md): Retrieve Bible text for a book/chapter/verse range in the requested translation.
- [Get Scripture](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-get.md)
- [Get Items by Scripture](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-items.md): Find all items tagged with a specific scripture reference.
- [List Scriptures](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-list.md)
- [Update Scripture](https://developer.thehaystack.ai/api-reference/endpoints/scriptures-update.md): Update metadata on a scripture. Pass `displayOrder` to reorder; subsequent siblings shift automatically.
- [Search Content](https://developer.thehaystack.ai/api-reference/endpoints/search.md): Semantic search across sermons, scriptures, and series. By default returns all results in a single JSON response. When `stream=true`, returns a text/event-stream with these message types:
- [Delete Series Artwork](https://developer.thehaystack.ai/api-reference/endpoints/series-artwork-delete.md)
- [Upload Series Artwork](https://developer.thehaystack.ai/api-reference/endpoints/series-artwork-upload.md): Upload artwork for a series as multipart/form-data. Supports the same variant types as item artwork.
- [Create Series](https://developer.thehaystack.ai/api-reference/endpoints/series-create.md)
- [Get Series](https://developer.thehaystack.ai/api-reference/endpoints/series-get.md)
- [List Series](https://developer.thehaystack.ai/api-reference/endpoints/series-list.md): List sermon series. Supports `_expand=items` to include items per series.
- [Update Series](https://developer.thehaystack.ai/api-reference/endpoints/series-update.md)
- [Create Speaker](https://developer.thehaystack.ai/api-reference/endpoints/speakers-create.md): Create a new speaker
- [Delete Speaker](https://developer.thehaystack.ai/api-reference/endpoints/speakers-delete.md)
- [Get Speaker](https://developer.thehaystack.ai/api-reference/endpoints/speakers-get.md)
- [Delete Speaker Image](https://developer.thehaystack.ai/api-reference/endpoints/speakers-image-delete.md)
- [Upload Speaker Image](https://developer.thehaystack.ai/api-reference/endpoints/speakers-image-upload.md)
- [List Speakers](https://developer.thehaystack.ai/api-reference/endpoints/speakers-list.md): Retrieve all speakers
- [Update Speaker](https://developer.thehaystack.ai/api-reference/endpoints/speakers-update.md)
- [Click Position Distribution](https://developer.thehaystack.ai/api-reference/endpoints/stats-click-position.md): Positions of clicked search results.
- [Click-Through Metrics](https://developer.thehaystack.ai/api-reference/endpoints/stats-click-through.md): Search result click-through rates.
- [Media Plays](https://developer.thehaystack.ai/api-reference/endpoints/stats-media-plays.md): Media play counts over time.
- [Page View Metrics](https://developer.thehaystack.ai/api-reference/endpoints/stats-page-views.md): Page view counts over time.
- [Search Media Play Rates](https://developer.thehaystack.ai/api-reference/endpoints/stats-search-media-play-rates.md): Rate at which searches lead to media plays.
- [Search Media Plays Duration](https://developer.thehaystack.ai/api-reference/endpoints/stats-search-media-plays-duration.md): Duration of media plays initiated from search.
- [Search Quality Score Distribution](https://developer.thehaystack.ai/api-reference/endpoints/stats-search-quality-score-distribution.md): Histogram of search result scores.
- [Search Quality Time Series](https://developer.thehaystack.ai/api-reference/endpoints/stats-search-quality-time-series.md): Aggregated search quality score over time.
- [Top Items](https://developer.thehaystack.ai/api-reference/endpoints/stats-top-items.md): Top-performing items (limit/offset supported).
- [Top Series](https://developer.thehaystack.ai/api-reference/endpoints/stats-top-series.md): Top-performing series.
- [Trending Topics](https://developer.thehaystack.ai/api-reference/endpoints/stats-trending-topics.md): Topics with rising engagement over the range.
- [Underperforming Topics](https://developer.thehaystack.ai/api-reference/endpoints/stats-underperforming-topics.md): Topics with low engagement or poor search quality.
- [API Reference](https://developer.thehaystack.ai/api-reference/introduction.md): Complete endpoint documentation for the Haystack API
- [Authentication](https://developer.thehaystack.ai/authentication.md): Learn how to authenticate your API requests to Haystack
- [Content Model](https://developer.thehaystack.ai/concepts/content-model.md): Understanding how content is organized in Haystack
- [Media Management](https://developer.thehaystack.ai/concepts/media-management.md): How Haystack handles video and audio assets
- [Search & Discovery](https://developer.thehaystack.ai/concepts/search-discovery.md): How Haystack's semantic search works
- [Managing Content](https://developer.thehaystack.ai/guides/managing-content.md): Complete guide to creating and organizing content in Haystack
- [Working with Media](https://developer.thehaystack.ai/guides/working-with-media.md): Upload and manage video and audio content
- [Getting Started](https://developer.thehaystack.ai/index.md): Build powerful content discovery experiences with semantic search and intelligent media management
- [Quick Start](https://developer.thehaystack.ai/quickstart.md): Get started with the Haystack API in 5 minutes

## OpenAPI Specs

- [openapi](https://developer.thehaystack.ai/api-reference/openapi.json)