Skip to content
em sa em sa

IP generation configuration status

GET
/api/ip/config
 
curl --request GET \
  --url 'https://example.com/api/ip/config?deal_id=example' \
  --header 'Authorization: Bearer <token>'

Returns IP feature flags: PDF enabled (Gotenberg), Gamma API configured, and minimum coverage threshold. Requires Editor access. Useful for ops to diagnose why PDF or deck generation is unavailable.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
deal_id
required
Deal Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
IPConfigResponse

IP generation configuration status (admin diagnostics).

object
pdf_enabled
required
Pdf Enabled
boolean
gotenberg_url_configured
required
Gotenberg Url Configured
boolean
gamma_configured
required
Gamma Configured
boolean
minimum_coverage_pct
required
Minimum Coverage Pct
number
Example generated
{
  "pdf_enabled": true,
  "gotenberg_url_configured": true,
  "gamma_configured": true,
  "minimum_coverage_pct": 1
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}