Run Intake Agent

Run the Intake Agent asynchronously on one or more contract documents to extract form field values for a counterparty paper workflow.

Documents can be provided in two ways:

  • multipart/form-data — Upload one or more files as separate form parts. Each file must have a distinct field name (e.g. file0, file1). The template is sent as a form field.
  • application/json — Provide a fileUrls array of publicly accessible URLs. Each URL must return the file bytes directly on GET (no authentication). Private documents (e.g. Google Docs without anonymous sharing) are not supported via URL — download them and upload via multipart instead.

Files must have a .pdf, .doc, or .docx extension. Filenames must be unique within a request (extension case is ignored, so contract.pdf and contract.PDF count as duplicates). Up to 10 files per request on either path. The total size of all files in a request must not exceed 100MB.

The template must accept counterparty paper and have Intake Agent enabled.

OAuth Scope required: public.agents.runIntakeAgent

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The identifier of the workflow template. Available template identifiers can be retrieved via the List All Workflow Schemas endpoint.

fileUrls
array of strings
required
length between 1 and 10

Publicly accessible URLs that return file bytes on GET. Each URL is fetched server-side.

fileUrls*
Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json