Company APIs

Company Needs

Surface recent pain points, challenges, or other requested topics from a company’s official filings as concise, structured highlights. Both company_name and content (the topic to surface) are required; an optional filing restricts the search to one filing type. The request is queued asynchronously and returns a request_id; poll the status endpoint or supply a callback_url. The completed result includes a needs array with one entry per matching filing excerpt (filing, content, date, and source URL) - an empty array when nothing matches. Analysis typically takes 15-60 seconds. A credit is charged only when the analysis produces results.

POST https://api.nyne.ai/company/needs API key

API Key API Secret

Manual credentials take precedence over your account key.

Try it needs these required parameters:

Overview

Summarize pain points / challenges from a company’s official filings.

Parameters

company_name string required

Company to analyze, e.g. “Uber Technologies, Inc.”. Max 255 chars.

content string required

Topic to surface, e.g. “Regulatory challenges”, “Supply chain issues”. Max 255 chars.

filing string optional

Restrict to a filing type, e.g. “Form 10-K”, “Form 8-K”. Max 255 chars.

callback_url string optional

http(s) URL on an allowed host that receives the completed payload automatically.

Polling for the result

This endpoint is asynchronous. A successful submit returns a request_id while the job runs in the background. Poll the same path with a GET request - same authentication headers - passing the request_id as a query parameter:

Loading your API credentials...

Each poll returns the job's current status; once it is completed the payload carries the result shown under Responses. Polling an unknown or expired request_id returns 404 request_not_found.

Status	Meaning
queued · processing · pending	The job is still running - keep polling.
completed	The job finished; the payload carries the result and completed: true.
failed	Terminal - the job could not complete; the error field explains why.

Poll every few seconds at first, backing off for long-running jobs. Polling is free - status checks never burn credits.

Prefer push delivery?

Supply the optional callback_url parameter and the completed payload is POSTed to your endpoint when the job finishes - no polling required. Delivery is retried up to 5 times with exponential backoff (1s, 5s, 15s, 1m, 5m) and a 30-second timeout per attempt; respond with a 2xx status to acknowledge receipt.

Credit usage

Credits are charged based on the matched configuration. The listed cost is the per-result unit price.

Feature	Credits	Notes
Needs Analysis	-	Charged once when the analysis produces results
No data	0	No relevant filings never burns credits

Heads up

A positive credit balance is required before each request. Empty results do not burn credits.

Responses

202 Needs analysis queued - poll the status endpoint with the returned request_id

400 missing_parameters / invalid_parameters / invalid_callback_url

401 Missing or invalid API credentials

403 subscription_required or ip_not_allowed

404 no needs data found (no credit charged)

429 rate_limit_exceeded / monthly_limit_exceeded

503 service_unavailable - the API is temporarily unavailable

A successful response wraps the payload in the { success, data, timestamp } envelope (also shown live in the panel on the right):

{
  "success": true,
  "data": {
    "request_id": "64f2d8e4nd1f065a9b4e7fbc3df6aabb_1700000456_7710",
    "status": "completed",
    "completed": true,
    "result": {
      "company": "Uber Technologies, Inc.",
      "needs": [
        {
          "filing": "Form 10-K",
          "content": "Notes increased regulatory compliance costs across multiple regions.",
          "filing_date": "2025-02-14",
          "source_url": "https://www.sec.gov/Archives/edgar/data/1543151/uber-20241231x10k.htm"
        }
      ]
    },
    "completed_on": "2026-01-15T10:35:00Z"
  },
  "timestamp": "2026-01-01T00:00:00"
}