Skip to main content

Public REST/JSON reference

AI Disclosure API

Maintain AI-feature disclosures that satisfy EU AI Act, NYC Local Law 144, California ADMT, and similar frameworks. Register the AI features in your product, classify their risk tier per framework, generate the disclosure copy (HTML + Markdown), publish to your site, and diff version-to-version when regulations change. Part of the Logic Igniter Content & Marketing bundle.

Access boundary

These examples describe public API calls only. Use the service output to review, score, summarize, analyze, or recommend; do not treat the API reference as permission for an assistant to write, send, publish, charge, schedule, notify, delete, or modify records.

Base URL

https://api.logicigniter.com

Auth

Authorization: Bearer YOUR_API_KEY

Version

OpenAPI 3.0.3 · 1.0.0

Operations rendered

17

Response models rendered

31

GET/api/v1/aidisclosure/health

Service liveness

Liveness probe — returns 200 if the service is reachable.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/health" \
  -H "Accept: application/json"

Responses

200

Service healthy

GET/api/v1/aidisclosure/customers

List customers

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of customers

Missing or invalid API key.

POST/api/v1/aidisclosure/customers

Provision a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: CreateCustomerRequest

Sample JSON payload for evaluation.

{
  "email": "[email protected]",
  "name": "Example Inc."
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/customers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","name":"Example Inc."}'

Responses

Customer created or returned

Invalid email or missing name

Missing or invalid API key.

GET/api/v1/aidisclosure/customers/{id}

Get a customer by id

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring (uuid)

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Customer record

Missing or invalid API key.

Customer not found

PUT/api/v1/aidisclosure/customers/{id}

Update a customer

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring (uuid)

Request body (required)

Schema: UpdateCustomerRequest

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/aidisclosure/customers/:id" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{}'

Responses

Updated customer

Invalid update

Missing or invalid API key.

Customer not found

GET/api/v1/aidisclosure/features

List registered AI features

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/features" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of features

Missing or invalid API key.

POST/api/v1/aidisclosure/features

Register an AI feature

Register a single AI-powered feature in your product. Use the feature id later to classify against a framework or include in a disclosure.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: RegisterFeatureRequest

Sample JSON payload for evaluation.

{
  "name": "copilot-suggestions",
  "description": "LLM-backed inline code completion",
  "ai_type": "AI_TYPE_GENERATIVE"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/features" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"name":"copilot-suggestions","description":"LLM-backed inline code completion","ai_type":"AI_TYPE_GENERATIVE"}'

Responses

Feature registered

Missing name or invalid ai_type

Missing or invalid API key.

POST/api/v1/aidisclosure/features/{id}/classify

Classify a feature against a framework

Run the framework's risk classifier against a registered feature. Returns the assigned risk tier and the list of disclosure topics that the framework requires for this feature.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring (uuid)

Request body (required)

Schema: ClassifyFeatureRequest

Sample JSON payload for evaluation.

{
  "framework_id": "eu-ai-act-2024"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/features/:id/classify" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"framework_id":"eu-ai-act-2024"}'

Responses

Classification

Missing framework_id or unsupported framework

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers feature registration and framework browsing; paid plans unlock classification, generation, publishing, and rule overrides.

Feature not found

POST/api/v1/aidisclosure/scan

Scan a manifest for AI features

Submit a manifest of your codebase / product surface (the format is intentionally opaque — accepts whatever shape your team produces) and get back the AI features detected, with auto-suggested ai_type and risk_tier for each.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: ScanFeaturesRequest

Sample JSON payload for evaluation.

{
  "manifest_json": "{\"features\":[{\"name\":\"copilot\",\"description\":\"LLM-backed code completion\"}]}"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/scan" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"manifest_json":"{\"features\":[{\"name\":\"copilot\",\"description\":\"LLM-backed code completion\"}]}"}'

Responses

Detected features

Empty or unparseable manifest_json

Missing or invalid API key.

POST/api/v1/aidisclosure/disclosures/generate

Generate a disclosure

Render a fresh disclosure (HTML + Markdown) covering one or more frameworks. Status defaults to DRAFT — call /publish to actually push it.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request body (required)

Schema: GenerateDisclosureRequest

Sample JSON payload for evaluation.

{
  "framework_ids": [
    "eu-ai-act-2024",
    "nyc-ll144"
  ]
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/disclosures/generate" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"framework_ids":["eu-ai-act-2024","nyc-ll144"]}'

Responses

Generated disclosure

Empty framework_ids or unknown framework

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers feature registration and framework browsing; paid plans unlock classification, generation, publishing, and rule overrides.

POST/api/v1/aidisclosure/disclosures/{id}/publish

Publish a disclosure

Publish the disclosure to the configured target (e.g. your site's `/ai-disclosure` page, a webhook, a CMS document). Returns success + the published URL.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring (uuid)

Request body (required)

Schema: PublishDisclosureRequest

Sample JSON payload for evaluation.

{
  "target_id": "site-page-ai-disclosure"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X POST "https://api.logicigniter.com/api/v1/aidisclosure/disclosures/:id/publish" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"target_id":"site-page-ai-disclosure"}'

Responses

Publish result

Missing or unknown target_id

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers feature registration and framework browsing; paid plans unlock classification, generation, publishing, and rule overrides.

Disclosure not found

GET/api/v1/aidisclosure/disclosures/current

Get the current published disclosure

Returns the latest PUBLISHED disclosure. Useful for embedding the disclosure on your site at request-time.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/disclosures/current" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Current disclosure

Missing or invalid API key.

No disclosure published yet

GET/api/v1/aidisclosure/disclosures/history

List disclosure history

Versioned history of published disclosures, with diff summaries from version to version. Useful for auditor questions like "what did your AI disclosure say on date X?".

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/disclosures/history" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of history entries

Missing or invalid API key.

GET/api/v1/aidisclosure/disclosures/diff

Diff two disclosure versions

Section-by-section diff between any two published versions. Each section reports whether it was ADDED / REMOVED / MODIFIED / UNCHANGED with the old and new text.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
version_arequiredquerystring
version_brequiredquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/disclosures/diff" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Diff result

Missing version_a or version_b

Missing or invalid API key.

One or both versions not found

GET/api/v1/aidisclosure/frameworks

List supported regulatory frameworks

Catalog of frameworks Logic Igniter currently supports — EU AI Act, NYC Local Law 144, California ADMT, etc. — with their jurisdiction, version, and effective dates.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
page_sizequeryinteger
page_tokenquerystring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/frameworks" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Page of frameworks

Missing or invalid API key.

GET/api/v1/aidisclosure/frameworks/{id}/requirements

Get framework requirements

Per-category requirements for a single framework — transparency, consent, data rights, accountability, safety, risk tiering, consumer notice/rights, bias audit. Each requirement includes the description, who it covers, the consumer rights granted, and the penalty text for non-compliance.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X GET "https://api.logicigniter.com/api/v1/aidisclosure/frameworks/:id/requirements" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Responses

Framework requirements

Missing or invalid API key.

Framework not found

PUT/api/v1/aidisclosure/frameworks/{id}/rules

Override framework classification rules

Replace the JSON rules used to classify features against this framework. Useful for workspace-specific risk-tolerance overrides or for previewing a regulation update before Logic Igniter ships the new defaults.

Public REST/JSON operation

This operation is documented for direct API evaluation. It describes the public payload and response contract only; assistant/MCP usage remains read only and is covered in the MCP guide.

Parameters

NameInTypeNotes
idrequiredpathstring

Request body (required)

Schema: UpdateRulesRequest

Sample JSON payload for evaluation.

{
  "rules_json": "{\"high_risk_categories\":[\"biometric\",\"hiring\"]}"
}

Request example

Replace placeholders with your confirmed access key and your own business data.

curl -X PUT "https://api.logicigniter.com/api/v1/aidisclosure/frameworks/:id/rules" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"rules_json":"{\"high_risk_categories\":[\"biometric\",\"hiring\"]}"}'

Responses

Updated framework

Unparseable rules_json

Missing or invalid API key.

Endpoint requires an active subscription. Free tier covers feature registration and framework browsing; paid plans unlock classification, generation, publishing, and rule overrides.

Framework not found

Data models

Error

FieldTypeNotes
errorrequiredstring

AIType

RiskTier

DisclosureStatus

ChangeType

RequirementCategory

Feature

FieldTypeNotes
idstring (uuid)
namestring
descriptionstring
ai_typeAIType
risk_tierRiskTier
detected_atstring (date-time)

RegisterFeatureRequest

FieldTypeNotes
namerequiredstring
descriptionstring
ai_typeAIType

ListFeaturesResponse

FieldTypeNotes
itemsarray<Feature>
next_page_tokenstring
total_countinteger

ClassifyFeatureRequest

FieldTypeNotes
framework_idrequiredstring

FeatureClassification

FieldTypeNotes
idstring (uuid)
feature_idstring (uuid)
framework_idstring
risk_tierRiskTier
required_disclosuresarray<string>

DetectedFeature

FieldTypeNotes
namestring
ai_typeAIType
risk_tierRiskTier
descriptionstring

ScanFeaturesRequest

FieldTypeNotes
manifest_jsonrequiredstring

ScanFeaturesResponse

FieldTypeNotes
featuresarray<DetectedFeature>

GenerateDisclosureRequest

FieldTypeNotes
framework_idsrequiredarray<string>

Disclosure

FieldTypeNotes
idstring (uuid)
framework_idstring
content_htmlstring
content_markdownstring
versioninteger
statusDisclosureStatus
created_atstring (date-time)
updated_atstring (date-time)

PublishDisclosureRequest

FieldTypeNotes
target_idrequiredstring

PublishResult

FieldTypeNotes
idstring (uuid)
successboolean
target_urlstring (uri)
published_atstring (date-time)

DisclosureHistoryEntry

FieldTypeNotes
idstring (uuid)
disclosure_idstring (uuid)
versioninteger
publish_targetstring
diff_summarystring
published_atstring (date-time)

ListHistoryResponse

FieldTypeNotes
itemsarray<DisclosureHistoryEntry>
next_page_tokenstring
total_countinteger

DiffSection

FieldTypeNotes
section_namestring
change_typeChangeType
old_textstring
new_textstring

DiffResult

FieldTypeNotes
idstring (uuid)
sectionsarray<DiffSection>

Framework

FieldTypeNotes
idstring
namestring
jurisdictionstringExample: "EU"
versionstring
rules_jsonstring
effective_datestring (date-time)
created_atstring (date-time)

ListFrameworksResponse

FieldTypeNotes
itemsarray<Framework>
next_page_tokenstring
total_countinteger

Requirement

FieldTypeNotes
categoryRequirementCategory
descriptionstring
covered_entitiesarray<string>
consumer_rightsarray<string>
penalty_textstring

FrameworkRequirements

FieldTypeNotes
idstring (uuid)
framework_idstring
requirementsarray<Requirement>

UpdateRulesRequest

FieldTypeNotes
rules_jsonrequiredstring

CreateCustomerRequest

FieldTypeNotes
emailrequiredstring (email)
namerequiredstring

UpdateCustomerRequest

FieldTypeNotes
emailstring (email)
namestring

Customer

FieldTypeNotes
idstring (uuid)
emailstring (email)
namestring
created_atstring (date-time)

CustomersResponse

FieldTypeNotes
itemsarray<Customer>
next_page_tokenstring
total_countinteger