API Reference

Returns the account associated with the token — plan, credit balance, remaining analysis slots, and feature limits.

{
  "data": {
    "id": 1,
    "name": "Acme Agency",
    "email": "[email protected]",
    "plan": { "key": "agency", "name": "Agency", "is_subscriber": true },
    "credits": { "balance": 42 },
    "limits": {
      "can_submit_analysis": true,
      "remaining_analyses": 10,
      "analyses_this_period": 40,
      "max_analyses_per_period": 50
    }
  }
}

List your profiles, newest first.

Create a new profile. Supports Idempotency-Key.

{
  "data": {
    "id": "01KS7BDHFPV10MP72CJE07Y0VN",
    "label": "Spookyloopz",
    "type": "creator",
    "vertical_pack": "generic",
    "platforms": [
      { "platform": "instagram", "handle": "spookyloopz", "url": "https://instagram.com/spookyloopz" }
    ],
    "created_at": "2026-05-22T13:00:00+00:00"
  }
}

Single profile with platforms, fetched metrics, and intelligence grade.

Update profile fields. Accepts the same fields as POST; all are optional.

List analyses, newest first. The list omits the heavy report.content body — fetch the single-item endpoint to get full content.

Submit a new analysis. Deducts one credit from your balance. If an identical analysis is already in-flight, returns 200 with meta.in_flight: true and no credit is charged. Supports Idempotency-Key.

{
  "data": {
    "id": "01KS8AZMF4E2XN3G7JKWRDHQ01",
    "status": "processing",
    "gene": { "key": "traffic_gene", "label": "Traffic Gene" },
    "profile": { "id": "01KS7BDHFPV10MP72CJE07Y0VN", "label": "Spookyloopz" },
    "report": null,
    "created_at": "2026-05-22T13:01:04+00:00",
    "started_at": null,
    "completed_at": null
  },
  "meta": { "credits_charged": 1 }
}

Poll GET /analyses/{id} until status is completed or failed, or register a webhook to avoid polling.

Single analysis with full report.content. Content shape varies by gene — treat unknown keys defensively.

{
  "data": {
    "id": "01KS7VWT2B6W8G6D2BKAGDNJYW",
    "status": "completed",
    "gene": { "key": "traffic_gene", "label": "Traffic Gene" },
    "profile": { "id": "01KS7BDHFPV10MP72CJE07Y0VN", "label": "Spookyloopz" },
    "report": {
      "reference_number": "PKK-WEEV-2PBX",
      "title": "Traffic Gene: Spookyloopz",
      "schema_version": "1.0",
      "public_summary": "Audience looks credible, with search-driven traffic.",
      "content": { /* gene-specific sections */ }
    },
    "created_at": "2026-05-22T12:52:19+00:00",
    "completed_at": "2026-05-22T12:52:28+00:00"
  }
}

The report object only — same shape as in the single-analysis response, without surrounding metadata. Returns 404 until the report exists. Useful for polling.

Download the report as a PDF. Returns binary application/pdf. Returns 404 if the report is not yet complete.

List available analysis types. Use the key field as gene_key when submitting an analysis. available_to_you reflects your current plan.

{
  "data": [
    {
      "key": "traffic_gene",
      "label": "Traffic Gene",
      "description": "Assesses traffic source patterns and audience credibility.",
      "credit_cost": 1,
      "available_to_you": true
    }
  ]
}

List checks. Accepts ?status= and ?per_page=.

Submit a check. If the same subject was researched recently and a cached result is available, returns it immediately at no credit cost. Supports Idempotency-Key.

{
  "data": {
    "id": "01KS8BZMF4E2XN3G7JKWRDHQ02",
    "status": "processing",
    "subject": "example.com",
    "content": null
  },
  "meta": { "resolution": "live", "credits_charged": 1 }
}

A cached hit returns 200 with meta.resolution: "cache" and credits_charged: 0.

Single check. When status is completed, the content field contains the cited assessment.

List comparisons.

Create a comparison. Both analyses must be completed and use the same gene. Returns 422 if the genes differ ("Both reports must come from the same analysis type to be compared."). Supports Idempotency-Key.

Single comparison with verdict and content.

List workspaces.

Create a workspace. Body: name (required), description (optional), profile_ids[] (optional). Supports Idempotency-Key.

Single workspace with member profiles.

Update name or description.

Delete workspace (profiles are not deleted).

Attach profiles. Body: { profile_ids: [ulid, …] }.

Detach a profile from the workspace.

List webhook endpoints.

Single webhook endpoint.

Delete a webhook endpoint.

Register a new webhook endpoint. HTTPS only. The signing secret is returned once in the response — store it immediately.

{
  "data": {
    "id": "01KS8CZMF4E2XN3G7JKWRDHQ03",
    "url": "https://example.com/pinkk-hook",
    "events": ["analysis.completed", "analysis.failed"],
    "enabled": true,
    "secret": "whsec_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  }
}
// secret is shown only in this response — store it immediately.

Enable or disable an endpoint, update events, or change the description. Send only the fields you want to change.