IMimentiv

Create Brief

Changed on

Combine several of your ready digests into one cross-document brief.

Chunk ids must be unique across the documents in one brief (prefix them with a document id). A digest that is not ready answers 409 digest_not_ready. Cached, polled and billed like a digest.

post/v2/insights/briefs

Request

  • Base URL
    https://api.imentiv.ai (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

productstring nullable
wait_snumber

How long to wait for a new result before answering 202 running.

ttl_daysinteger

How long a finished result is kept.

digest_keysstring[] required
brief_versionstring required

Response

Successful Response

status'ready' | 'running' | 'failed' required
brief_keystring required
briefobject nullable
cachedboolean
expires_atstring date-time nullable

Changes