Start a persisted keyword research job
Enqueue a bulk keyword research job. The job is processed asynchronously by the Python worker. Poll the returned job ID to retrieve results once status transitions to ‘completed’. Counts against keyword_lookups_daily quota.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Path Parameters
Body
Request body for starting a persisted bulk keyword research job.
Attributes: research_type: One of 'bulk', 'suggestions', or 'domain_keywords'. input_params: Payload forwarded to the worker — keywords list, location_code, language_code, domain, etc.
Response
Successful Response
Full response model for a KeywordResearchJob record.
Attributes: id: UUID of the job record. org_id: Organization this job belongs to. project_id: Optional project scope. status: Current lifecycle state (pending, processing, completed, failed). research_type: Type of research that was requested. input_params: Original request parameters passed to the worker. results_data: Keyword result rows once the job completes. result_count: Number of result rows returned. error_message: Error detail when status is 'failed'. completed_at: Timestamp when the job transitioned to completed/failed. created_by: UUID of the user who started the job. created_at: Record creation timestamp. updated_at: Record last-modified timestamp.