Skip to main content
Opik Documentation
current

Search documentation

Type to search this documentation.

Enrol projects in the auto-first-run rollout

POST/v1/internal/agent-insights/enrollmentEnrol projects in the auto-first-run rollout

Enrols the given projects, creating their job row if needed, or clears their enrolment. Idempotent.

Request body

required
application/json
objectRequest
enrolledbooleanrequired

True enrols the given projects, false clears their enrolment

project_idsarray of string · uuidrequired

maxItems 500 · minItems 0

Show child attributes

maxItems 500 · minItems 0

Example request
{
  "enrolled": true,
  "project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}

Responses

200Enrollment resultapplication/json
objectResponse
already_run_project_idsarray of string · uuid

Ids whose automatic run already happened, so enrolling has no effect

uniqueItems true

Show child attributes

uniqueItems true

clearedinteger · int32
enrolledinteger · int32
unknown_project_idsarray of string · uuid

Ids that match no project

uniqueItems true

Show child attributes

uniqueItems true

Example response
{
  "already_run_project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "cleared": 0,
  "enrolled": 0,
  "unknown_project_ids": [
    "00000000-0000-0000-0000-000000000000"
  ]
}
Documentation menu