Intakes

Get intake results

Return the typed results for all items. This is the primary endpoint an agent calls once the intake is completed. Set only_new=true to receive only items approved since the last call (useful for streaming partial results from a long intake). Set include_pending=true to include items not yet submitted.

get/v1/intakes/{id}/results

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/intakes/{id}/results
  • Auth: HTTP bearer

Path parameters

idstring required

Intake ID

Query parameters

only_newboolean

Return only items approved since the last call to this endpoint.

include_pendingboolean

Include items that have not been submitted yet.

exclude_secretsboolean

Leave secret items out without revealing them, so their one-time reveal stays available. Meant for integrations that log every response.

Response

Typed results keyed by item key

intake_idstring required
status'draft' | 'sent' | 'in_progress' | 'completed' | 'archived' required
missingstring[] required

Keys of the required items the client still owes. Empty means nothing is outstanding. Unaffected by only_new and include_pending, so it answers "can I keep building?" on every call rather than only the first. A decision the agent answered itself is not listed — the value came back, and meta.<key>.decided_by says whose it is.

resultsobject required

Object keyed by item key. Each value is the typed answer for that item type: a string for text, an array for color_list and file_list, one file object for file and image, and for a secret an object carrying the plaintext value. A secret is released once — see the secrets guide — and requires the secrets:read or admin scope; without it the key appears in meta with secret_unavailable instead.

metaobject required

Per-key detail about the answer above, keyed the same way.

Example response

{
  "intake_id": "in_01J9Z8X",
  "missing": [
    "hero_image",
    "ga4_id"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.