Signals

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

POST
GET
POST
POST
GET
GET
GET
POST
POST
GET
GET
GET
POST
GET
GET
POST
GET
PATCH
POST
POST

Create signals report checks replace

Atomically replace an open agent or metric check with a metric check. The old check stays live if the new one is invalid.

Required API key scopes

inbox:writequery:read

Path parameters

  • id
    string
  • report_id
    string

Request parameters

  • title
    string
  • rationale
    string
  • config
  • soak_minutes
    integer
  • run_interval_minutes
    integer
  • runs_remaining
    integer

Response


Example request

POST /api/projects/:project_id/signals/reports/:report_id/checks/:id/replace
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/:report_id/checks/:id/replace/\
-d title="string",\
-d config=undefined

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"rationale": "string",
"kind": "metric_threshold",
"status": "pending",
"config": {
"metric_id": null,
"query": null,
"monitoring": null,
"comparison": {
"operator": "lte",
"value": null,
"bounds": null
},
"baseline_value": null,
"metric_kind": null,
"value_format": null,
"unit": null
},
"monitoring_timing": {
"state": "scheduled",
"final_verification_state": "monitoring",
"started_at": "2019-08-24T14:15:22Z",
"ends_at": "2019-08-24T14:15:22Z",
"next_measurement_at": "2019-08-24T14:15:22Z"
},
"approved_at": "2019-08-24T14:15:22Z",
"next_run_at": "2019-08-24T14:15:22Z",
"soak_minutes": 0,
"run_interval_minutes": 0,
"runs_remaining": 0,
"expires_at": "2019-08-24T14:15:22Z",
"last_run_at": "2019-08-24T14:15:22Z",
"last_outcome": "passed",
"last_outcome_reason": "awaiting_data",
"dispatched_at": "2019-08-24T14:15:22Z",
"consecutive_errors": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve signals reports available reviewers

Required API key scopes

inbox:read

Query parameters

  • query
    string

Example request

GET /api/projects/:project_id/signals/reports/available_reviewers
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/available_reviewers/

Example response

Status 200 Up to 100 candidate reviewers keyed by user UUID.

Create signals reports bulk state

Transition many reports to a new state in one call.

Each id is processed independently: a report whose transition isn't allowed from its current status is reported as skipped (a 409 on the single-report endpoint) and the rest still go through. Returns one result per requested id (in request order, after de-duplication) plus per-outcome counts. The whole call is 200 even on partial failure — inspect results / the counts to see what happened.

Required API key scopes

inbox:write

Request parameters

  • state
  • dismissal_reason
  • dismissal_note
    string
  • corrected_repository
    string
  • snooze_for
    integer
  • ids
    array

Response


Example request

POST /api/projects/:project_id/signals/reports/bulk-state
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/bulk-state/\
-d state=undefined,\
-d ids="array"

Example response

Status 200
RESPONSE
{
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"outcome": "string",
"status": "string",
"detail": "string"
}
],
"transitioned_count": 0,
"skipped_count": 0,
"failed_count": 0,
"not_found_count": 0
}

Create signals reports bulk

Claim many reports for the current user, internal task, or external agent in one call. Each id is claimed independently, and the call is 200 even when some claims are refused: inspect results and the counts. Use the single-report claim endpoint to release a claim or to add pull requests.

Required API key scopes

inbox:write

Request parameters

  • ids
    array
  • takeover_agent_claims
    boolean
    Default: false

Response


Example request

POST /api/projects/:project_id/signals/reports/bulk_claim
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/bulk_claim/\
-d ids="array"

Example response

Status 200
RESPONSE
{
"results": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"outcome": "string",
"detail": "string"
}
],
"claimed_count": 0,
"conflict_count": 0,
"not_found_count": 0
}

Retrieve signals reports for me

Your open inbox reports, ranked for you by one language model call over your activity summary, the reports that need you and the ranking model's predictions. Each entry has a reason and a compact report. The request never waits on the model. By default it returns the last stored list quickly, and checked_at says how current it is. Pass max_age_minutes to check an older list against every candidate report, which can take some seconds. refresh, focus and your first request start a background build and set building: true. With no stored list, the request returns your reports in inbox order with fallback_reason: building. Pass wait_seconds to wait a short time for the new list. Only the user the list is about can read it.

Required API key scopes

inbox:read

Query parameters

  • focus
    string
  • limit
    integer
  • max_age_minutes
    integer
  • refresh
    boolean
    Default: false
  • wait_seconds
    integer
    Default: 0

Response


Example request

GET /api/projects/:project_id/signals/reports/for_me
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/for_me/

Example response

Status 200
RESPONSE
{
"status": "ready",
"personalized": true,
"cached": true,
"stale": true,
"building": true,
"fallback_reason": "string",
"generated_at": "2019-08-24T14:15:22Z",
"checked_at": "2019-08-24T14:15:22Z",
"latency_ms": 0,
"activity_summary_version": 0,
"candidates_considered": 0,
"ranked_count": 0,
"results": [
{
"rank": 0,
"tier": "top",
"reason": "string",
"next_step": "string",
"matched": {
"theme": "string",
"needs_you": [
"suggested_reviewer"
]
},
"ranked_by": "llm",
"report": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"status": "potential",
"priority": "P0",
"implementation_pr_state": "unknown",
"ranking": {
"status": "scored",
"model": "string",
"scored_at": "2019-08-24T14:15:22Z",
"predictions": [
{
"outcome": "open",
"probability": 0.1,
"lift": 0,
"readable": true
}
]
}
}
}
],
"folded": [
{
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"into_report_id": "288f0ad6-5492-4963-9b0b-8d9198f73994",
"reason": "string"
}
]
}
Status 404 Personal ranking is not available to the caller.

Retrieve signals reports pr ci

Resolve the coarse CI rollup of the pull requests several reports opened, so a list of reports can show which pull requests are red without opening each report. One GitHub call covers the whole batch, and the answers are cached briefly and shared across callers. A report is left out when it has no open implementation pull request, and also when GitHub could not answer for it (no integration reaches the repository, a rate limit, an upstream failure), so a caller shows no CI state for it rather than an error. For the individual checks behind the rollup, use pr_checks.

Required API key scopes

inbox:read

Query parameters

  • report_ids
    string

Response


Example request

GET /api/projects/:project_id/signals/reports/pr_ci_statuses
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/pr_ci_statuses/

Example response

Status 200 The CI rollup of each requested report's implementation pull request.
RESPONSE
{
"statuses": [
{
"report_id": "5ed7905a-4735-4cf7-b1ab-521e066fb971",
"ci_status": "passing"
}
]
}
Status 400 `report_ids` is missing, not a list of UUIDs, or over the cap.

List all signals reports ranking outcomes

What each public outcome of the served ranking model predicts, with its horizon, cohort, base rate and readability from the model that scored this project's reports. Users who cannot see the ranking model get status not_available and no outcomes.

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/reports/ranking_outcomes
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/ranking_outcomes/

Example response

Status 200
RESPONSE
{
"status": "scored",
"model": "string",
"outcomes": [
{
"outcome": "open",
"label": "string",
"description": "string",
"horizon_days": 0,
"cohort": "string",
"base_rate": 0,
"readable": true
}
]
}

Create signals reports read state

Required API key scopes

inbox:read

Request parameters

  • report_ids
    array
  • read
    boolean

Response


Example request

POST /api/projects/:project_id/signals/reports/read_state
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/read_state/\
-d report_ids="array"

Example response

Status 200
RESPONSE
{
"states": {
"property1": true,
"property2": true
}
}

Create signals reports refresh metrics

Re-run the stored metric queries of the given reports through the query cache and save the newest values as their snapshots. Call it when a person opens the inbox list or a report, with the ids on screen. Report titles and summaries are point-in-time text and never change here; only value, value_at, and series do, and legacy comparisons are cleared. A snapshot measured in the last 15 minutes is served as is. Each call runs at most 40 source series inside a 20-second budget, row metrics first; the rest keep their previous snapshot until the next open. Returns snapshot-only metrics for every requested report the caller can read whose status is ready or pending_input, or monitoring when Monitoring is enabled. A report in any other status is left out of the response, and its saved snapshots stay as they are.

Required API key scopes

inbox:read

Request parameters

  • report_ids
    array

Response


Example request

POST /api/projects/:project_id/signals/reports/refresh_metrics
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/refresh_metrics/\
-d report_ids="array"

Example response

Status 200
RESPONSE
{
"reports": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"metrics": [
{
"metric_id": "string",
"title": "string",
"kind": "affected_users",
"role": "supporting",
"value": 0,
"value_at": "2019-08-24T14:15:22Z",
"series": [
0.1
],
"series_buckets": [
"string"
],
"value_format": "number",
"unit": "string",
"caption": "string",
"goal_value": 0,
"goal_direction": "at_most",
"goal_grain": "whole_window",
"decision_window_days": 1,
"minimum_data_points": 1,
"interval": "string"
}
]
}
]
}

Retrieve signals reports refund summary

Aggregate credited-path refunds across the whole organization for the current billing period — counts only, no per-team detail. The billing usage widget needs this because billing usage is org-wide while reports (and their refunds) are team-scoped: subtract the refunded credits from billing usage to show the net PR count. Excluded-path refunds never reach billing usage, so no adjustment is needed for them. Also carries the org's live billable credits for the period (billing's recorded usage lags by up to a day), so the widget can count just-created PRs and react to same-day refunds.

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/reports/refund-summary
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/refund-summary/

Example response

Status 200 Org-wide credited-refund totals for the current billing period.
RESPONSE
{
"credited_refund_count": 0,
"credited_credits": 0,
"period_billable_credits": 0,
"quota_limited": true
}
Status 404 Refunds are not enabled for this organization.


Retrieve signals reports section counts

Count the ready reports with and without an implementation pull request, in one query. Accepts the list's filters, so each count matches a count_only list request with status=ready and the matching has_implementation_pr. Rejects status, has_implementation_pr, include_all_statuses and view, because the counts set those.

Required API key scopes

inbox:read

Query parameters

  • actionability
    string
  • already_addressed
    boolean
  • assignee
    string
    One of: "me""mine"
  • channel_id
    string
  • connected
    string
  • created_after
    string
  • created_before
    string
  • exclude
    array
  • include_unlisted
    boolean
    Default: false
  • needs_you
    boolean
  • priority
    string
  • ranking_min_lift
    string
  • ranking_min_probability
    string
  • scope
    string
  • scout
    string
  • scout_prefix
    string
  • search
    string
  • source_id
    string
  • source_product
    string
  • suggested_reviewers
    string
  • tags
    array
  • task_id
    string
  • teammate_uuid
    string
  • unclaimed
    boolean
  • unread
    boolean
  • use_priority_preference
    boolean

Response


Example request

GET /api/projects/:project_id/signals/reports/section_counts
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/section_counts/

Example response

Status 200
RESPONSE
{
"pull_requests": 0,
"reports": 0
}

Create signals reports source metadata

Read which source products contributed signals to each given report, and which scout authored it. These values come from ClickHouse, so the inbox list skips them (include_source_metadata=false) and calls this after the rows render. Returns one entry per requested id. An id with no signals in this project gets empty values.

Required API key scopes

inbox:read

Request parameters

  • report_ids
    array

Response


Example request

POST /api/projects/:project_id/signals/reports/source_metadata
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/source_metadata/\
-d report_ids="array"

Example response

Status 200
RESPONSE
{
"reports": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"source_products": [
"string"
],
"scout_name": "string"
}
]
}

Retrieve signals reports tag options

Required API key scopes

inbox:read

Response


Example request

GET /api/projects/:project_id/signals/reports/tag_options
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reports/tag_options/

Example response

Status 200
RESPONSE
{
"tags": [
"string"
]
}

List all signals reviewer exclusions

List the standing instructions that keep you off automatic reviewer selection, active and revoked.

Required API key scopes

inbox:read

Example request

GET /api/projects/:project_id/signals/reviewer_exclusions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reviewer_exclusions/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Create signals reviewer exclusions

Required API key scopes

inbox:write

Request parameters

  • repository
    string
  • path_prefix
    string
  • instruction
    string
  • report_id
    string

Response


Example request

POST /api/projects/:project_id/signals/reviewer_exclusions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reviewer_exclusions/\
-d instruction="string"

Example response

Status 200 An active instruction already covers this area, so nothing new is saved.
RESPONSE
{
"instruction_saved": true,
"report_removed": true,
"exclusion": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"detail": "string"
}
Status 201
RESPONSE
{
"instruction_saved": true,
"report_removed": true,
"exclusion": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"detail": "string"
}
Status 207 The report removal succeeded but the instruction is not saved. Send the request again.
RESPONSE
{
"instruction_saved": true,
"report_removed": true,
"exclusion": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
},
"detail": "string"
}
Status 400
RESPONSE
{
"detail": "string"
}
Status 404
RESPONSE
{
"detail": "string"
}

Retrieve signals reviewer exclusions

Required API key scopes

inbox:read

Path parameters

  • id
    string

Response


Example request

GET /api/projects/:project_id/signals/reviewer_exclusions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reviewer_exclusions/:id/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update signals reviewer exclusions

Required API key scopes

inbox:write

Path parameters

  • id
    string

Request parameters

  • repository
    string
  • path_prefix
    string
  • instruction
    string

Response


Example request

PATCH /api/projects/:project_id/signals/reviewer_exclusions/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reviewer_exclusions/:id/\
-d repository="string"

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
Status 400
RESPONSE
{
"detail": "string"
}

Create signals reviewer exclusions revoke

Make you eligible for automatic reviewer selection in this area again. Revoking does not add you to any report, and it does not change old reports.

Required API key scopes

inbox:write

Path parameters

  • id
    string

Response


Example request

POST /api/projects/:project_id/signals/reviewer_exclusions/:id/revoke
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/reviewer_exclusions/:id/revoke/

Example response

Status 200
RESPONSE
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"repository": "string",
"path_prefix": "string",
"instruction": "string",
"status": "active",
"revision": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Create signals scout

Create a scout skill and its runnable config atomically. Give it a display_name — the label people read, kept exactly as written — and the scout's permanent skill name is generated from it, with a numeric suffix when that name is taken, so two scouts may share a label without sharing an identity. Pass name instead to pick that identifier yourself; any valid skill name works, since the config row is what makes a skill a scout. The skill always receives the report-channel tools. The optional config controls schedule, enablement, dry-run posture, network access, and typed destinations such as Slack. Repeating the same definition is safe and applies any supplied config fields; reusing an explicit name for a different definition returns 409.

Required API key scopes

llm_skill:writesignal_scout:write

Request parameters

  • display_name
    string
  • name
    string
  • description
    string
  • body
    string
  • files
    Click to open
    array
  • config
  • suggestion_id
    string

Response


Example request

POST /api/projects/:project_id/signals/scout
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl
-H 'Content-Type: application/json'\
-H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
<ph_app_host>/api/projects/:project_id/signals/scout/\
-d description="string",\
-d body="string"

Example response

Status 200 The scout definition already existed; the requested config fields were applied.
RESPONSE
{
"created": true,
"skill": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"version": 0,
"allowed_tools": [
"string"
]
},
"config": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"skill_name": "string",
"description": "string",
"display_name": "string",
"scout_origin": "canonical",
"scout_role": "specialist",
"deprecation": {
"phase": "announced",
"reason": "string",
"superseded_by": "string",
"sunset_at": "2019-08-24T14:15:22Z"
},
"owners": [
{
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"distinct_id": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_email_verified": true,
"hedgehog_config": {},
"role_at_organization": "engineering"
}
],
"enabled": true,
"status": "active",
"pause_reason": "no_output",
"managed_by": "team",
"emit": true,
"run_interval_minutes": 30,
"run_cron_schedule": "string",
"output_destinations": {
"slack": {
"integration_id": 1,
"channel": "string",
"users": [
"string"
],
"thread_reports": true
},
"webhook": {
"hog_function_id": "string"
},
"inbox": true
},
"structured_output_schema": {},
"network_access": "trusted",
"model": "string",
"custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
"mcp_gateway_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"repositories": [
"string"
],
"write_scopes": [
"string"
],
"report_actions": [
"string"
],
"max_report_actions_per_day": 20,
"lifecycle_locked": true,
"allowed_mcp_tools": [
"string"
],
"tool_preset": "string",
"precheck_query": "string",
"precheck_disabled": true,
"effective_precheck_query": "string",
"precheck_query_source": "config",
"last_precheck_at": "2019-08-24T14:15:22Z",
"last_precheck_outcome": "run",
"last_precheck_row_count": 0,
"last_run_at": "2019-08-24T14:15:22Z",
"consecutive_failure_count": 0,
"status_changed_at": "2019-08-24T14:15:22Z",
"status_changed_by": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"distinct_id": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_email_verified": true,
"hedgehog_config": {},
"role_at_organization": "engineering"
},
"auto_pause_exempt": true,
"tags": [
"string"
],
"source_product": "string",
"source_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
Status 201 The scout skill, config, or both were created.
RESPONSE
{
"created": true,
"skill": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"version": 0,
"allowed_tools": [
"string"
]
},
"config": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"skill_name": "string",
"description": "string",
"display_name": "string",
"scout_origin": "canonical",
"scout_role": "specialist",
"deprecation": {
"phase": "announced",
"reason": "string",
"superseded_by": "string",
"sunset_at": "2019-08-24T14:15:22Z"
},
"owners": [
{
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"distinct_id": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_email_verified": true,
"hedgehog_config": {},
"role_at_organization": "engineering"
}
],
"enabled": true,
"status": "active",
"pause_reason": "no_output",
"managed_by": "team",
"emit": true,
"run_interval_minutes": 30,
"run_cron_schedule": "string",
"output_destinations": {
"slack": {
"integration_id": 1,
"channel": "string",
"users": [
"string"
],
"thread_reports": true
},
"webhook": {
"hog_function_id": "string"
},
"inbox": true
},
"structured_output_schema": {},
"network_access": "trusted",
"model": "string",
"custom_image_id": "871a86c2-b20e-4ced-8336-55149e45aaf7",
"mcp_gateway_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"repositories": [
"string"
],
"write_scopes": [
"string"
],
"report_actions": [
"string"
],
"max_report_actions_per_day": 20,
"lifecycle_locked": true,
"allowed_mcp_tools": [
"string"
],
"tool_preset": "string",
"precheck_query": "string",
"precheck_disabled": true,
"effective_precheck_query": "string",
"precheck_query_source": "config",
"last_precheck_at": "2019-08-24T14:15:22Z",
"last_precheck_outcome": "run",
"last_precheck_row_count": 0,
"last_run_at": "2019-08-24T14:15:22Z",
"consecutive_failure_count": 0,
"status_changed_at": "2019-08-24T14:15:22Z",
"status_changed_by": {
"id": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"distinct_id": "string",
"first_name": "string",
"last_name": "string",
"email": "user@example.com",
"is_email_verified": true,
"hedgehog_config": {},
"role_at_organization": "engineering"
},
"auto_pause_exempt": true,
"tags": [
"string"
],
"source_product": "string",
"source_id": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
Status 400 The scout definition, config, or destination is invalid.
Status 409 A scout with this name already exists with a different definition.