Observer Docs

POST

incidents

{id}

draft

Draft the next customer update with AI, plus the evidence appendix it was written against (never publishes)

curl --request POST \
  --url https://use.observer/api/v1/incidents/{id}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://use.observer/api/v1/incidents/{id}/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://use.observer/api/v1/incidents/{id}/draft"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "draft": {
    "title": "<string>",
    "severity": "minor",
    "status": "Investigating",
    "affected_service_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "message": "<string>"
  },
  "reason": "<string>",
  "evidence": {
    "schema_version": 123,
    "computed_at": "2023-11-07T05:31:56Z",
    "impact": {
      "basis": "status_changes",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "ongoing": true,
      "duration_minutes": 123,
      "worst_status": "degraded",
      "periods": 123,
      "started_before_lookback": true
    },
    "services": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "checks": [
      {}
    ],
    "customers": {},
    "slo_burn": [
      {}
    ],
    "related_changes": [
      {}
    ],
    "observers": {},
    "coverage": {},
    "notes": [
      "<string>"
    ]
  }
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Authorizations

Authorization

string

header

required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs.

Path Parameters

string<uuid>

required

Incident id.

Body

application/json

status

enum<string>

Write the draft for this message type.

Available options:

Investigating,

Identified,

Information,

Resolved

severity

enum<string>

Keep this severity.

Available options:

minor,

major,

critical

Response

ok. draft is null when no draft could be made; reason says why (disabled, opted_out, not_entitled, budget_exceeded, global_cap, rate_limited, invalid_output, timeout, error). The evidence appendix is always returned.

draft

object | null

Show child attributes

reason

string | null

evidence

object

What Observer measured about the incident, computed in code (not by AI). Related changes are listed by timing only, never as causes.

Show child attributes

Draft the next customer update with AI, plus the evidence appendix it was written against (never publishes)

curl --request POST \
  --url https://use.observer/api/v1/incidents/{id}/draft \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://use.observer/api/v1/incidents/{id}/draft', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://use.observer/api/v1/incidents/{id}/draft"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "draft": {
    "title": "<string>",
    "severity": "minor",
    "status": "Investigating",
    "affected_service_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "message": "<string>"
  },
  "reason": "<string>",
  "evidence": {
    "schema_version": 123,
    "computed_at": "2023-11-07T05:31:56Z",
    "impact": {
      "basis": "status_changes",
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z",
      "ongoing": true,
      "duration_minutes": 123,
      "worst_status": "degraded",
      "periods": 123,
      "started_before_lookback": true
    },
    "services": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ],
    "checks": [
      {}
    ],
    "customers": {},
    "slo_burn": [
      {}
    ],
    "related_changes": [
      {}
    ],
    "observers": {},
    "coverage": {},
    "notes": [
      "<string>"
    ]
  }
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

{
  "type": "https://docs.use.observer/api/getting-started/errors#forbidden",
  "title": "forbidden",
  "status": 403,
  "detail": "missing scope: write:incidents"
}

Getting started

Account

Status pages

Services

Metrics

SLOs

SLA statements

Incidents

Maintenances

Config as code

Agents

Change events

Audit log

Draft an incident update

Authorizations

Path Parameters

Body

Response