Get Started

Outtake API overview

Key endpoints and usage patterns

Welcome to the high-level guide for working with the Outtake API. Use this page to get oriented, review authentication, and explore common request patterns before diving into the full API reference.

For the complete OpenAPI specification, head to the API Reference tab or open the spec in the Swagger Editor.

Base URL

All requests target the following base URL unless otherwise noted:

https://app.outtake.ai/api/v1

Getting started

Authentication

All requests require a bearer token. Add it to the Authorization header on every call.

$Authorization: Bearer YOUR_API_KEY

Generate and manage your keys from the API Keys tab inside the Outtake dashboard. Rotate keys regularly and revoke any that are no longer in use.

Rate limits

Outtake enforces per-endpoint and per-organization rate limits to ensure platform stability. Every response includes rate limit headers so you can inspect your current usage. Contact your Outtake representative if you need higher thresholds for a specific integration.

Core workflows

Use /search for fast lookups across indexed content, and switch to /async-search when you need discovery jobs that continue gathering results in the background. Exact-match discovery on Twitter/X is available via /async-search-exact. See the Search guide for request parameters, polling patterns, and best practices.

Collections

Collections organize narratives and power engagement analytics. List active collections, seed new ones with POST /collections, and pull aggregate, daily, or author-level insights as needed. Automated discovery via emergent collections helps you track new narratives without manual curation. Explore the Collections guide for workflow diagrams and sample responses.

Takedown analytics

The takedown analytics endpoints provide program-level KPIs such as resolve rate, SLA adherence, and time-to-resolution. Start with /takedowns/summary for a high-level snapshot, then break performance down by registrar, host, platform, or country using /takedowns/summary/groups. The Takedown analytics guide walks through filters, metrics, and reporting tips.

Webhooks

Subscribe to workflow and alert events to trigger downstream automation in real time. Webhooks support event filtering, custom headers, configurable retry policies, and signing secret rotation. The Webhooks guide covers subscription management, delivery validation, and operational safeguards.

Next steps

  • Deep dive into the Search, Collections, Takedown analytics, and Webhooks guides.
  • Review authentication details and environment setup in the API Reference.
  • Explore schema definitions in the reference to plan analytics pipelines.
  • Connect with your Outtake partner manager if you need custom workflows or elevated rate limits.