Please log in to access your API credentials and start using our APIs.
Log In & Start Free Trial
Summarize recent pain points, challenges, or other requested content from a company's official filings. Returns concise, structured highlights.
Related Endpoints
Overview
API Endpoint
https://api.nyne.ai/company/needs
- Endpoint:
POST /company/needs - Delivery: Asynchronous. Receive a
request_id, then poll or register a callback. - Credits: 3 credits each time a summary is produced.
- Freshness: Focuses on recent filings.
Authentication
Authenticate every request with your API key and secret:
Headers
X-API-Key: your_api_key_hereX-API-Secret: your_api_secret_here
Rate Limits
Company needs requests are subject to standard Nyne.ai rate limits for your plan:
- Per Minute: 60 requests
- Per Hour: 1000 requests
- Monthly: Varies by plan
Credit Usage
API credits are consumed for company needs analysis requests:
- Needs Analysis: 3 credits per completed analysis
Credit Efficiency
Credits are charged when the analysis produces results. If no relevant filings are found, no credits are charged.
POST /company/needs
Queue a filing analysis request.
POST /company/needs
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
company_name |
string | required | Company to analyze (e.g. “Uber Technologies, Inc.”). |
content |
string | required | Topic to surface (e.g. “Regulatory challenges”, “Supply chain issues”). |
filing |
string | optional | Restrict to a filing type (e.g. “Form 10-K”, “Form 8-K”). |
callback_url |
string | optional | HTTPS endpoint to receive the completed payload automatically. |
Example Request
{
"company_name": "Uber Technologies, Inc.",
"content": "Regulatory challenges",
"filing": "Form 10-K",
"callback_url": "https://example.com/webhooks/company-needs"
}
cURL Example
Queue a Needs Analysis
curl -X POST https://api.nyne.ai/company/needs \
-H "X-API-Key: your_api_key_here" \
-H "X-API-Secret: your_api_secret_here" \
-H "Content-Type: application/json" \
-d '{
"company_name": "Apple Inc.",
"content": "Supply chain challenges"
}'
Immediate Response
{
"success": true,
"data": {
"request_id": "coneeds_64f2d8e4_1700000456",
"status": "queued",
"message": "Company needs request queued. Use GET /company/needs?request_id=... to check status.",
"callback_url": "https://example.com/webhooks/company-needs"
},
"timestamp": "2025-11-10T22:32:03Z"
}
GET /company/needs
Poll for completion or retrieve cached results.
GET /company/needs
Query Parameters
request_id(string, required) – identifier returned by the POST call.
cURL Example
Poll for Results
curl -X GET "https://api.nyne.ai/company/needs?request_id=coneeds_64f2d8e4_1700000456" \ -H "X-API-Key: your_api_key_here" \ -H "X-API-Secret: your_api_secret_here"
Completed Response
{
"success": true,
"data": {
"request_id": "coneeds_64f2d8e4_1700000456",
"status": "completed",
"result": {
"company": "Uber Technologies, Inc.",
"needs": [
{
"filing": "Form 10-K",
"content": "Notes increased regulatory compliance costs in multiple regions.",
"filing_date": "2025-02-14",
"source_url": "https://www.sec.gov/Archives/edgar/data/0001543151/000154315125000012/uber-20241231x10k.htm"
}
]
},
"created_on": "2025-11-10T22:32:03Z",
"completed_on": "2025-11-10T22:32:41Z"
},
"timestamp": "2025-11-10T22:32:41Z"
}
Callback Payload
If callback_url is provided, the same JSON payload is POSTed to your endpoint when results are ready.
Callback Example
POST https://example.com/webhooks/company-needs
Content-Type: application/json
{
"request_id": "coneeds_64f2d8e4_1700000456",
"status": "completed",
"result": {
"company": "Uber Technologies, Inc.",
"needs": [
{
"filing": "Form 10-K",
"content": "Notes increased regulatory compliance costs in multiple regions.",
"filing_date": "2025-02-14",
"source_url": "https://www.sec.gov/Archives/edgar/data/0001543151/000154315125000012/uber-20241231x10k.htm"
}
]
},
"created_at": "2025-11-10T22:32:03Z",
"completed_at": "2025-11-10T22:32:41Z"
}
Error Codes
missing_parameters–company_nameorcontentomitted.invalid_callback_url– Callback URL must be HTTPS.subscription_required– Account lacks enrichment product access.rate_limit_exceeded/monthly_limit_exceeded– Usage limits exceeded.
Next Steps
- Experiment with the Company Needs Playground.
- Explore related APIs: Company Search, Company Enrichment, Company CheckSeller.