# AskElephant | API Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.askelephant.ai/_mcp/server

## Docs

- [AskElephant Developer Docs](https://docs.askelephant.ai/welcome.md): Integration-first docs for the current public API surface
- [Getting started](https://docs.askelephant.ai/getting-started.md): Make a first successful contacts request against the public `v2` API
- [Authentication and scopes](https://docs.askelephant.ai/authentication-and-scopes.md): Send the correct Authorization header and request the scopes your integration needs
- [Errors and retries](https://docs.askelephant.ai/errors.md): Problem details, auth failures, not founds, and rate-limit handling
- [Rate limits](https://docs.askelephant.ai/rate-limits.md): Workspace limits, response headers, and client backoff guidance
- [Resource model](https://docs.askelephant.ai/resource-model.md): The live contact resource shape and the conventions it follows
- [Pagination and filtering](https://docs.askelephant.ai/pagination.md): Cursor traversal plus the live hybrid query contract
- [Scopes matrix](https://docs.askelephant.ai/scopes-matrix.md): The current endpoint-to-scope mapping for the live API
- [Webhooks](https://docs.askelephant.ai/webhooks.md): Real-time event notifications for resource changes
- [Support](https://docs.askelephant.ai/support.md): Where to send implementation questions
- [Bulk exports and incremental syncs](https://docs.askelephant.ai/bulk-exports.md): Recommended patterns for backfills and ongoing sync jobs using `updated_at`
- [Searching engagements](https://docs.askelephant.ai/searching-engagements.md): Common patterns for filtering engagements by CRM associations, contacts, companies, and transcript data
- [Filter engagements by CRM object IDs](https://docs.askelephant.ai/filtering-engagements-by-crm-object-ids.md): Use CRM company, contact, and deal IDs with GET /v2/engagements
- [Dialer integration](https://docs.askelephant.ai/dialer-integration.md): Push calls from any dialer into AskElephant, deep-link back to the originating system, and retrieve AI-generated insights
- [Import a call from another platform](https://docs.askelephant.ai/call-import.md): Create an AskElephant engagement from a recording and an existing transcript
- [MCP servers](https://docs.askelephant.ai/mcp-servers.md): Connect AskElephant to Claude, ChatGPT, and Cursor
- [Claude](https://docs.askelephant.ai/claude.md): Add AskElephant as a custom connector in Claude
- [ChatGPT](https://docs.askelephant.ai/chatgpt.md): Add AskElephant as a custom app or MCP connector in ChatGPT
- [Cursor](https://docs.askelephant.ai/cursor.md): Configure AskElephant in Cursor with remote MCP URLs

## API Docs

- API Reference > Webhook Events [Contact created](https://docs.askelephant.ai/api-reference/webhook-events/contact-created-webhook.md)
- API Reference > Webhook Events [Contact updated](https://docs.askelephant.ai/api-reference/webhook-events/contact-updated-webhook.md)
- API Reference > Webhook Events [Contact deleted](https://docs.askelephant.ai/api-reference/webhook-events/contact-deleted-webhook.md)
- API Reference > Webhook Events [Company created](https://docs.askelephant.ai/api-reference/webhook-events/company-created-webhook.md)
- API Reference > Webhook Events [Company updated](https://docs.askelephant.ai/api-reference/webhook-events/company-updated-webhook.md)
- API Reference > Webhook Events [Company deleted](https://docs.askelephant.ai/api-reference/webhook-events/company-deleted-webhook.md)
- API Reference > Webhook Events [Engagement created](https://docs.askelephant.ai/api-reference/webhook-events/engagement-created-webhook.md)
- API Reference > Webhook Events [Engagement updated](https://docs.askelephant.ai/api-reference/webhook-events/engagement-updated-webhook.md)
- API Reference > Webhook Events [Engagement deleted](https://docs.askelephant.ai/api-reference/webhook-events/engagement-deleted-webhook.md)
- API Reference > Webhook Events [Engagement transcript ready](https://docs.askelephant.ai/api-reference/webhook-events/engagement-processing-completed-webhook.md)
- API Reference > Webhook Events [Tag created](https://docs.askelephant.ai/api-reference/webhook-events/tag-created-webhook.md)
- API Reference > Webhook Events [Tag updated](https://docs.askelephant.ai/api-reference/webhook-events/tag-updated-webhook.md)
- API Reference > Webhook Events [Tag deleted](https://docs.askelephant.ai/api-reference/webhook-events/tag-deleted-webhook.md)
- API Reference > Authentication [Exchange OAuth credentials for an access token](https://docs.askelephant.ai/api-reference/authentication/oauth-token.md)
- API Reference > Transcript Comments [Get transcript comment](https://docs.askelephant.ai/api-reference/transcript-comments/get-transcript-comment-by-id.md)
- API Reference > Transcript Comments [Delete transcript comment](https://docs.askelephant.ai/api-reference/transcript-comments/delete-transcript-comment.md)
- API Reference > Transcript Comments [Update transcript comment](https://docs.askelephant.ai/api-reference/transcript-comments/update-transcript-comment.md)
- API Reference > Transcript Comments [List engagement transcript comments](https://docs.askelephant.ai/api-reference/transcript-comments/list-engagement-transcript-comments.md)
- API Reference > Transcript Comments [Create engagement transcript comment](https://docs.askelephant.ai/api-reference/transcript-comments/create-engagement-transcript-comment.md)
- API Reference > Companies [List companies](https://docs.askelephant.ai/api-reference/companies/list-companies.md)
- API Reference > Companies [Create company](https://docs.askelephant.ai/api-reference/companies/create-company.md)
- API Reference > Companies [Get company](https://docs.askelephant.ai/api-reference/companies/get-company-by-id.md)
- API Reference > Companies [Delete company](https://docs.askelephant.ai/api-reference/companies/delete-company.md)
- API Reference > Companies [Update company](https://docs.askelephant.ai/api-reference/companies/update-company.md)
- API Reference > Companies [Set company CRM association](https://docs.askelephant.ai/api-reference/companies/set-company-crm-association.md)
- API Reference > Companies [Clear company CRM association](https://docs.askelephant.ai/api-reference/companies/clear-company-crm-association.md)
- API Reference > Engagements [List company engagements](https://docs.askelephant.ai/api-reference/engagements/list-company-engagements.md)
- API Reference > Engagements [List contact engagements](https://docs.askelephant.ai/api-reference/engagements/list-contact-engagements.md)
- API Reference > Engagements [List engagements](https://docs.askelephant.ai/api-reference/engagements/list-engagements.md)
- API Reference > Engagements [Create engagement](https://docs.askelephant.ai/api-reference/engagements/create-engagement.md)
- API Reference > Engagements [Get engagement](https://docs.askelephant.ai/api-reference/engagements/get-engagement-by-id.md)
- API Reference > Engagements [Replace engagement contacts](https://docs.askelephant.ai/api-reference/engagements/replace-engagement-contacts.md)
- API Reference > Engagements [Replace engagement tags](https://docs.askelephant.ai/api-reference/engagements/replace-engagement-tags.md)
- API Reference > Engagements [Set engagement CRM association](https://docs.askelephant.ai/api-reference/engagements/set-engagement-crm-association.md)
- API Reference > Engagements [Clear engagement CRM association](https://docs.askelephant.ai/api-reference/engagements/clear-engagement-crm-association.md)
- API Reference > Contacts [List contacts](https://docs.askelephant.ai/api-reference/contacts/list-contacts.md)
- API Reference > Contacts [Create contact](https://docs.askelephant.ai/api-reference/contacts/create-contact.md)
- API Reference > Contacts [Get contact](https://docs.askelephant.ai/api-reference/contacts/get-contact-by-id.md)
- API Reference > Contacts [Delete contact](https://docs.askelephant.ai/api-reference/contacts/delete-contact.md)
- API Reference > Contacts [Update contact](https://docs.askelephant.ai/api-reference/contacts/update-contact.md)
- API Reference > Contacts [Set contact CRM association](https://docs.askelephant.ai/api-reference/contacts/set-contact-crm-association.md)
- API Reference > Contacts [Clear contact CRM association](https://docs.askelephant.ai/api-reference/contacts/clear-contact-crm-association.md)
- API Reference > Transcript Timelines [Get engagement transcript timeline](https://docs.askelephant.ai/api-reference/transcript-timelines/get-engagement-transcript-timeline.md)
- API Reference > Tags [List tags](https://docs.askelephant.ai/api-reference/tags/list-tags.md)
- API Reference > Tags [Create tag](https://docs.askelephant.ai/api-reference/tags/create-tag.md)
- API Reference > Tags [Get tag](https://docs.askelephant.ai/api-reference/tags/get-tag-by-id.md)
- API Reference > Tags [Delete tag](https://docs.askelephant.ai/api-reference/tags/delete-tag.md)
- API Reference > Tags [Update tag](https://docs.askelephant.ai/api-reference/tags/update-tag.md)
- API Reference > Users [List users](https://docs.askelephant.ai/api-reference/users/list-users.md)
- API Reference > Users [Get user](https://docs.askelephant.ai/api-reference/users/get-user-by-id.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.askelephant.ai/openapi.json)
- [OpenAPI YAML](https://docs.askelephant.ai/openapi.yaml)