API Reference
Complete reference documentation for the IntentGPT B2B Intent API
Overview
The IntentGPT B2B Intent API provides powerful intent analysis capabilities for B2B companies. Our API enables you to analyze and track intent signals across companies and topics.
Base URL
All API requests should be made to:
Authentication
All API requests require authentication using an API key in the header:
Never share your API key or commit it to version control. API keys follow the format:
p1rOh.xxxxxxxxxxxxxxx.xxxxxxxxxxxx
Rate Limits
The API provides unlimited calls with responses limited to top 1000 rows.
Intent Endpoint
GET /intent
Retrieve intent data for specified companies and topics.
Example Request
Optional Parameters
Parameter | Type | Description |
---|---|---|
offset | integer | Starting point for returned rows, useful for pagination |
companies | string | Comma-separated list of company domains (e.g., “salesforce.com,oracle.com”) |
topics | string | One or more topics to filter intent data (e.g., “marketing”, “sales”) |
intent_levels | string | Filter by intent level: ONFIRE, HOT, WARM, COLD |
Example Requests with Parameters
Basic Request with Offset:
Filter by Companies:
Filter by Topics:
Filter by Intent Levels:
Combined Filters Example:
Intent Levels
The API uses four levels of intent:
Level | Description |
---|---|
ONFIRE | Highest intent level indicating immediate interest |
HOT | Strong intent signals |
WARM | Moderate intent signals |
COLD | Low or minimal intent signals |
Error Handling
The API uses conventional HTTP response codes:
2xx
- Success4xx
- Client errors (invalid API key, malformed request)5xx
- Server errors
SDKs and Libraries
While you can use the API directly with HTTP requests, we also provide official SDKs:
Support
Need help? Contact our support team:
- Email: support@intentgpt.ai
- Developer Community: community.intentgpt.ai
Looking to process more than 1000 rows? Contact our sales team at sales@intentgpt.ai to discuss enterprise options.