Base URL
All Topic API requests use:Authentication
All endpoints require a valid 1eye API key.$API_KEY as the environment variable containing your API key.
For more information, see Authentication.
Endpoints
All endpoints return JSON responses, except DELETE, which returns no response body.
Topic Object
A Topic represents a subject, technology, or business challenge relevant to your ideal customers. For example, Snowbricks, a fictional cloud data and AI platform, might track interest in lakehouse architecture, cloud data warehousing, data engineering, and machine learning infrastructure.Fields
Example Topic
System-Managed Fields
1eye automatically generates and maintains additional fields.
These fields are read-only and cannot be modified through Create or Update requests.
1. List Topics
GET /v1/kb/topics
Retrieve a paginated list of Topics configured in your workspace.
Query Parameters
Example Request
Example Response
200 OKPagination
When additional results are available,pagination.next_cursor contains a continuation token.
next_cursor is null, there are no additional results.
See Pagination.
Behavior
- Returns Topics belonging to the authenticated workspace.
- Excludes deleted Topics.
- Supports cursor-based pagination.
- Returns an empty
dataarray when no Topics exist.
2. Retrieve a Topic
GET /v1/kb/topics/{id}
Retrieve a specific Topic using its unique identifier.
Path Parameters
Example Request
Example Response
200 OKBehavior
- Returns the complete Topic record.
- Includes system-generated metadata.
- Returns
404 Not Foundif the Topic does not exist, has been deleted, or belongs to another workspace.
3. Create a Topic
POST /v1/kb/topics
Create a new Topic in your workspace.
New Topics become available for future Market Signals processing.
Request Body
Example Request
Example Response
201 CreatedBehavior
When a Topic is created:- 1eye generates a unique Topic ID.
- The Topic is associated with your workspace.
- The Topic appears in the Knowledge Base.
- The Topic becomes available for future Market Signals processing.
- The Topic can be retrieved or updated through the API.
Validation
namemust not be empty.short_namemust not be empty.descriptionmust not be empty.short_namemust be unique among active Topics in the workspace.- System-managed fields cannot be supplied.
4. Update a Topic
PATCH /v1/kb/topics/{id}
Update an existing Topic.
The API supports partial updates.
Request Body
At least one editable field must be supplied.
Example Request
Example Response
200 OKBehavior
- Updates only supplied fields.
- Preserves omitted fields.
- Preserves the original Topic ID.
- Reflects changes in the Console.
- Applies the updated Topic definition to future Market Signals processing.
5. Delete a Topic
DELETE /v1/kb/topics/{id}
Delete a Topic from your workspace.
Deletion performs a soft delete.
Example Request
Response
204 No Content The response body is empty.What Happens When a Topic Is Deleted?
- The Topic is removed from the active Knowledge Base.
- It no longer appears in List Topics.
- Retrieving the deleted Topic returns
404 Not Found. - The Topic is excluded from future Market Signals processing.
- Historical Signals associated with the Topic remain preserved.
6. How Topics Affect Market Signals
Topics help 1eye understand which areas of market research are relevant to your business. For example, Snowbricks might configure:
Market Signals can include activities such as:
researched_topicexplored_productevaluated_competitor
Knowledge Base Integration
Historical Data
Creating, updating, or deleting Topics does not automatically trigger historical signal generation or reevaluation. Existing records remain preserved.Console Synchronization
Changes made through the API are reflected in the 1eye Console, and vice versa.7. Error Handling
All Topic endpoints use the standard 1eye API error format.Example Error
404 Not Found8. Pagination & Rate Limits
List Topics supports cursor-based pagination.- Default page size: 100.
- Maximum page size: 1,000.
- Use
cursorfor subsequent pages. next_cursor: nullindicates no additional results.