AlphaSense
Ask AlphaSense GenSearch and search its filings, transcripts, broker research and expert-call library.
Connect AlphaSense with an API contract's key and client credentials plus a user's sign-in to ask GenSearch research questions with cited Markdown answers, search the document library by keyword, company, watchlist, type and date, resolve companies to AlphaSense ids, and read the user's watchlists. Everything runs as that user and GenSearch spends the contract's credits.
Connect
| Credential field | Required | Where it comes from |
|---|---|---|
API key (API_KEY) | Yes | The API key from your AlphaSense API contract, sent as X-Api-Key on every call. |
Client id (CLIENT_ID) | Yes | The OAuth client id AlphaSense issued with the contract. |
Client secret (CLIENT_SECRET) | Yes | The OAuth client secret AlphaSense issued with the contract. |
User email (USERNAME) | Yes | The AlphaSense user the automation acts as - their entitlements are the ceiling. |
User password (PASSWORD) | Yes | That user's AlphaSense password, used only to mint a short-lived bearer per call. |
Tools
| Tool | Access | What it does |
|---|---|---|
Ask (yekar.alpha-sense.ask) | Write | Ask AlphaSense GenSearch a research question and get a source-backed Markdown answer with inline [[N • Source]] citations into filings, transcripts, broker research, expert calls and news. Runs as the connected AlphaSense user and SPENDS that contract's GenSearch credits; deepResearch costs materially more. Filters AND together; documentIds answers from named documents instead. Waits up to waitSeconds and otherwise returns status pending with a conversationId for Get answer. |
Get answer (yekar.alpha-sense.get-answer) | Read | Read a GenSearch conversation started by Ask - the way to collect a deepResearch result or an answer that was still pending. Returns status answered, pending (with partial markdown and progress) or failed (with AlphaSense's error code). Reading spends no credits. |
Search documents (yekar.alpha-sense.search-documents) | Read | Search AlphaSense's document library - filings, earnings transcripts, broker research, expert calls, news and patents - by keyword expression, company, watchlist, type, industry, country and date. Returns document ids (for Ask's documentIds), metadata and, when a query is given, the matching statements with page numbers. totalCount is AlphaSense's own count of every match, not this page; page on with cursor. |
Search document images (yekar.alpha-sense.search-document-images) | Read | Find charts and tables inside documents - the figures in filings, decks and broker reports - using the same document filters as Search documents plus an image-type filter. Returns each image's id, kind and the document it sits in; totalCount is AlphaSense's own count of every match. |
Document counts (yekar.alpha-sense.document-counts) | Read | Count the documents matching a search, grouped by company, industry, country, or document type over time - how much coverage exists and who is being written about, without paging documents. Takes the same filters as Search documents. |
List saved searches (yekar.alpha-sense.list-saved-searches) | Read | The saved searches the connected user can run - personal, industry, suggested, shared-link, dashboard and template - with the ids Run saved search takes. Analysts keep their working filters here, so start with it before rebuilding a filter by hand. |
Run saved search (yekar.alpha-sense.run-saved-search) | Read | Run one of the user's saved searches by id, optionally overriding its date window, and page through the matching documents. Same document shape and totalCount as Search documents. |
Lookup companies (yekar.alpha-sense.lookup-companies) | Read | Resolve companies to AlphaSense company ids by name, ticker, ISIN, CIK or Crunchbase id - the ids that Search documents and Ask filter on. One result per input, in order; a null match means AlphaSense found nothing relevant for that entry. |
Company topics (yekar.alpha-sense.company-topics) | Read | A company's trending topics as AlphaSense scores them - relevance, momentum, affinity and mention sentiment over the last 12 or 24 months - the themes the market is discussing about it. count is AlphaSense's own total, not this page. |
Company summaries (yekar.alpha-sense.company-summaries) | Read | Which AI summary modules AlphaSense has prepared for a company (earnings, guidance, risks…), each with the document it was built from - so Ask can be pointed at that document with documentIds. Lists the modules and their sources; the summary prose itself is read through Ask. |
List brokers (yekar.alpha-sense.list-brokers) | Read | The broker research sources the connected user is entitled to, as a tree of codes and names - the vocabulary the brokers filter in Search documents takes. Reference data; spends nothing. |
List watchlists (yekar.alpha-sense.list-watchlists) | Read | The connected user's AlphaSense watchlists with their ids and companies - a watchlist id is the cheapest way to scope Search documents or Ask to a whole portfolio. Also the connection check: it proves the sign-in, the client credentials and the API key together. |
Create watchlist (yekar.alpha-sense.create-watchlist) | Write | Create a watchlist in the connected user's AlphaSense account with a name and an initial set of companies. shared makes it visible to the user's organisation. Returns the watchlist with its new id. |
Update watchlist (yekar.alpha-sense.update-watchlist) | Write | Rename a watchlist and/or REPLACE its whole company list - companyIds, when given, is the full set the watchlist will hold afterwards. To add or drop a few companies use Add watchlist companies / Remove watchlist companies instead. |
Add watchlist companies (yekar.alpha-sense.add-watchlist-companies) | Write | Add companies to an existing watchlist, keeping the ones already on it. |
Remove watchlist companies (yekar.alpha-sense.remove-watchlist-companies) | Write | Remove companies from a watchlist, leaving the rest in place. |
Delete watchlist (yekar.alpha-sense.delete-watchlist) | Write | Delete a watchlist from the connected user's account. There is no undo - confirm the id with List watchlists first. |
Export documents (yekar.alpha-sense.export-documents) | Write | Start an export of up to a handful of documents by id. Returns one task id per document; the file is not ready yet - poll Check export until it is AVAILABLE. Copies licensed content out of AlphaSense, which the user's contract governs. |
Check export (yekar.alpha-sense.check-export) | Read | The state of an export task from Export documents: AVAILABLE with the file URL, IN_PROGRESS, or ERROR. Reading spends nothing. |
Notes
- AlphaSense's API is enterprise-only: ask your AlphaSense account team (or [email protected]) for an Agent API or Utility APIs contract. It comes with an API key, a client id and a client secret - a normal product login cannot reach the API without them.
- Connect with those three values plus the email and password of the AlphaSense user the automation should act as. Every call runs as that user: their entitlements (broker research, expert calls, GenSearch) are the ceiling, and the connection holds their sign-in, so prefer a dedicated service user.
- Bind automations using this integration as a service connection - the password grant is an account-level identity, so "the person using it" has nothing to resolve.
- Ask spends the contract's GenSearch credits on every call and deepResearch costs materially more; the answer is Markdown with inline [[N • Source]] citations. A pending answer is collected later with Get answer.
- Every other tool is a Utility API call and spends no GenSearch credits. The watchlist writes and Export documents change or copy things in the user's account and are classified as writes. Only the SaaS gateway (api.alpha-sense.com) is supported - not a Private Cloud host.