API Reference
Search
Authorization
InfraApiKey AuthorizationBearer <token>
Send sk_live_* (production) or sk_test_* (test mode).
In: header
Query Parameters
q*Q
metric name / alias
Length
1 <= length <= 256limit?Limit
Range
1 <= value <= 200Default
50Response Body
application/json
application/problem+json
application/json
application/problem+json
curl -X GET "https://example.com/v1/metrics?q=string"{ "data": [ { "canonical_key": "gross_bookings", "display": "Gross Bookings", "definition": "Total dollar value transacted on the platform before incentives.", "unit": "USD", "basis": "reported", "category": "growth", "aliases": [ "GB", "bookings" ], "ticker": "UBER", "status": "active" } ], "pagination": { "next_cursor": null, "has_more": false }, "alpha": true, "query": "gross bookings"}{ "type": "https://docs.signals.ai/errors/invalid-key", "title": "Invalid API key", "status": 401, "detail": "Missing or invalid API key.", "request_id": "req_0dc23f9b4a0f8f2a", "instance": "/v1/companies/UBER"}{ "detail": [ { "type": "string_too_short", "loc": [ "body", "query" ], "msg": "String should have at least 2 characters", "input": "q", "ctx": { "min_length": 2 } } ]}{ "type": "https://docs.signals.ai/errors/rate-limited", "title": "Rate limit exceeded", "status": 429, "detail": "Your current plan's burst or daily quota has been exceeded.", "request_id": "req_8b44f5d1a8d1f48b", "instance": "/v1/search"}Authorization
InfraApiKey AuthorizationBearer <token>
Send sk_live_* (production) or sk_test_* (test mode).
In: header
Path Parameters
canonical_key*Canonical Key
Response Body
application/json
application/problem+json
application/json
application/problem+json
curl -X GET "https://example.com/v1/metrics/string"{ "canonical_key": "gross_bookings", "display": "Gross Bookings", "definition": "Total dollar value transacted on the platform before incentives.", "unit": "USD", "basis": "reported", "category": "growth", "aliases": [ "GB", "bookings" ], "status": "active", "companies": [ "UBER", "DASH" ], "company_count": 2, "alpha": true, "gap": "cross-company canonicalization is Layer 3 (not built); companies list is the per-ticker canonical_key match set"}{ "type": "https://docs.signals.ai/errors/invalid-key", "title": "Invalid API key", "status": 401, "detail": "Missing or invalid API key.", "request_id": "req_0dc23f9b4a0f8f2a", "instance": "/v1/companies/UBER"}{ "detail": [ { "type": "string_too_short", "loc": [ "body", "query" ], "msg": "String should have at least 2 characters", "input": "q", "ctx": { "min_length": 2 } } ]}{ "type": "https://docs.signals.ai/errors/rate-limited", "title": "Rate limit exceeded", "status": 429, "detail": "Your current plan's burst or daily quota has been exceeded.", "request_id": "req_8b44f5d1a8d1f48b", "instance": "/v1/search"}Authorization
InfraApiKey AuthorizationBearer <token>
Send sk_live_* (production) or sk_test_* (test mode).
In: header
Path Parameters
canonical_key*Canonical Key
Query Parameters
limit?Limit
Range
1 <= value <= 500Default
100Response Body
application/json
application/problem+json
application/json
application/problem+json
curl -X GET "https://example.com/v1/metrics/string/values"{ "data": [ { "ticker": "UBER", "metric_key": "gross_bookings", "period": { "calendar": null, "fiscal": "FY2026-Q1", "end_date": "2026-03-31", "kind": "quarter" }, "value": { "raw": 44800000000, "normalized": 44800000000, "unit": "USD", "original_unit": "USD", "conversion_factor": 1 }, "provenance": { "src_id": "src_kpi2_be16edbfefe50d35", "source_provider": "sec", "source_url": "https://www.sec.gov/Archives/edgar/data/1543151/000154315126000019/0001543151-26-000019-index.htm", "accession": "0001543151-26-000019", "quote": "Gross Bookings grew 25% YoY to $53.7 billion, and 21% on a constant currency basis.", "content_hash": null, "extracted_at": "2026-07-20T10:18:42.762293+00:00" } } ], "pagination": { "next_cursor": null, "has_more": false }, "alpha": true, "canonical_key": "gross_bookings"}{ "type": "https://docs.signals.ai/errors/invalid-key", "title": "Invalid API key", "status": 401, "detail": "Missing or invalid API key.", "request_id": "req_0dc23f9b4a0f8f2a", "instance": "/v1/companies/UBER"}{ "detail": [ { "type": "string_too_short", "loc": [ "body", "query" ], "msg": "String should have at least 2 characters", "input": "q", "ctx": { "min_length": 2 } } ]}{ "type": "https://docs.signals.ai/errors/rate-limited", "title": "Rate limit exceeded", "status": 429, "detail": "Your current plan's burst or daily quota has been exceeded.", "request_id": "req_8b44f5d1a8d1f48b", "instance": "/v1/search"}Authorization
InfraApiKey AuthorizationBearer <token>
Send sk_live_* (production) or sk_test_* (test mode).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/search" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{ "data": [ { "ref": { "chunk_id": 14913604, "ticker": "UBER", "source_kind": "transcript", "source_doc_id": 51791, "char_start": 0, "char_end": 155, "section_id": null, "event_id": 51791 }, "snippet": "Gross Bookings grew to $44.8 billion, up 18% year over year, as Mobility and Delivery both accelerated in the quarter.", "score": 0.9123, "published_at": "2026-05-07T00:00:00+00:00", "provenance": { "src_id": "src_search_0b91ec5a8cbfd7c3", "source_provider": "signals_transcript", "source_url": "disclosed://transcript/51791", "accession": null, "quote": "Gross Bookings grew to $44.8 billion, up 18% year over year.", "content_hash": null, "extracted_at": null } } ], "pagination": { "next_cursor": null, "has_more": false }, "query": "gross bookings growth"}{ "type": "https://docs.signals.ai/errors/invalid-key", "title": "Invalid API key", "status": 401, "detail": "Missing or invalid API key.", "request_id": "req_0dc23f9b4a0f8f2a", "instance": "/v1/companies/UBER"}{ "detail": [ { "type": "string_too_short", "loc": [ "body", "query" ], "msg": "String should have at least 2 characters", "input": "q", "ctx": { "min_length": 2 } } ]}{ "type": "https://docs.signals.ai/errors/rate-limited", "title": "Rate limit exceeded", "status": 429, "detail": "Your current plan's burst or daily quota has been exceeded.", "request_id": "req_8b44f5d1a8d1f48b", "instance": "/v1/search"}{ "type": "https://docs.signals.ai/errors/internal", "title": "Internal", "status": 503, "detail": "retrieval backend temporarily unavailable: search index warmup in progress", "request_id": "req_54e0dba80d730bb7", "instance": "/v1/search"}