Queue Deliverable

POST

api

public

intelligence-hub

runs

{run_id}

deliverables

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/intelligence-hub/runs/{run_id}/deliverables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "kind": "presentation",
  "redact_pii": true
}
'

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Headers

idempotency-key

string

required

Required string length: 1 - 200

X-UI-Organization-ID

string | null

Choose an organization you belong to for scoped reads, writes, and billing. Users can belong to multiple organizations. Platform administrators may select any organization in this app.

Maximum string length: 128

Path Parameters

run_id

string<uuid>

required

Body

application/json

kind

enum<string>

required

Available options:

presentation,

clip,

reel

evidence_ids

string[]

Required string length: 1 - 160

title

string | null

Maximum string length: 200

redact_pii

boolean

default:true

acknowledge_unredacted_audio

boolean

default:false

padding_seconds

number

default:1

Required range: 0 <= x <= 3

Response

Successful Response

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/intelligence-hub/runs/{run_id}/deliverables \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "kind": "presentation",
  "redact_pii": true
}
'

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

Overview

Runnable examples

Studies

Study lifecycle

Participants

Interviews and exports

Study reports

Intelligence Hub

Research search and answer

Panels, targeting and feasibility

External panels

Webhooks

Account, reference and usage

Organizations

Authorizations

Headers

Path Parameters

Body

Response