Create insights job config (Beta)

Create an Insights job configuration for a project.

POST /api/v1/sessions/{session_id}/insights/configs

Error

A valid request URL is required to generate request examples

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "config": {
    "name": "<string>",
    "hierarchy": [
      123
    ],
    "partitions": {},
    "sample": 123,
    "summary_prompt": "<string>",
    "filter": "<string>",
    "attribute_schemas": {},
    "model": "openai",
    "last_n_hours": 123,
    "start_time": "<string>",
    "end_time": "<string>",
    "user_context": {},
    "cluster_model": "<string>",
    "summary_model": "<string>"
  },
  "schedule_cron": "<string>"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

session_id · string<uuid> · required

Body

application/json

Request to create an Insights job configuration.

name · string · required

Maximum string length: 255

config · CreateRunClusteringJobRequest · object · required

Configuration for an Insights job.

Show child attributes

description · string | null

schedule_cron · string | null

Response

200

application/json

Successful Response

An Insights job configuration.

id · string<uuid> · required

name · string · required

description · string | null · required

config · SavedRunClusteringJobRequest · object · required

Saved configuration for an Insights job.

Show child attributes

schedule_cron · string | null