Add a pending document or website snapshot for receptionist fact review

POST

/v1/agents/{agent_id}/receptionist-intelligence/sources

curl --request POST \
  --url https://api.vocapable.com/v1/agents/example/receptionist-intelligence/sources \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "document", "label": "example", "content": "example", "source_url": "example", "provenance": "customer_upload", "extraction_report": { "title": "example", "extracted_characters": 1, "warnings": [ "example" ] } }'

Authorizations

• HTTPBearer

Parameters

Path Parameters

agent_id

required

Agent Id

string

Request Body^required

Media typeapplication/json

ReceptionistSourceCreateRequest

A pending immutable snapshot of a customer-provided document or website page.

Website contents are snapshots supplied/imported at a specific point in time. The live call path never fetches URLs and never follows arbitrary web content.

object

kind

required

Kind

string

Allowed values: document website

label

required

Label

string

>= 1 characters <= 255 characters

content

required

Content

string

>= 1 characters <= 100000 characters

source_url

Any of:

string

string

<= 2000 characters

null

null

provenance

Any of:

string

string

Allowed values: customer_upload customer_website_snapshot

null

null

extraction_report

Any of:

ReceptionistSourceExtractionReport

ReceptionistSourceExtractionReport

Bounded import evidence shown before a customer promotes facts into the draft.

object

title

Any of:

string

string

<= 500 characters

null

null

extracted_characters

required

Extracted Characters

integer

<= 100000

warnings

Warnings

Array<string>

<= 20 items

null

null

Responses

201

Successful Response

Media typeapplication/json

ReceptionistSourceSummary

object

id

required

Id

string

kind

required

Kind

string

Allowed values: document website

label

required

Label

string

source_url

Any of:

string

string

null

null

provenance

required

Provenance

string

Allowed values: customer_upload customer_website_snapshot

content_hash

required

Content Hash

string

content_characters

required

Content Characters

integer

content_token_count

required

Content Token Count

integer

extraction_report

required

ReceptionistSourceExtractionReport

Bounded import evidence shown before a customer promotes facts into the draft.

object

title

Any of:

string

string

<= 500 characters

null

null

extracted_characters

required

Extracted Characters

integer

<= 100000

warnings

Warnings

Array<string>

<= 20 items

refresh_status

required

Refresh Status

string

Allowed value: manual_refresh_required

refresh_of_source_id

Any of:

string

string

null

null

captured_at

required

Captured At

string format: date-time

review_status

required

Review Status

string

Allowed values: pending approved rejected

review_note

Any of:

string

string

null

null

reviewed_at

Any of:

string

string format: date-time

null

null

approved_at

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

Example

{
  "kind": "document",
  "provenance": "customer_upload",
  "refresh_status": "manual_refresh_required",
  "review_status": "pending"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}