Agents

Run Intake Agent

Changed on

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

post/intake-agent/run

Request

  • Base URL
    https://ironcladapp.com/public/api/v1
  • URL
    https://ironcladapp.com/public/api/v1/intake-agent/run
  • Auth
    API key in header Authorization and OAuth 2
    Authorization code: https://ironcladapp.com/oauth/authorize
    Client credentials
    Token URL: https://ironcladapp.com/oauth/token scopes: public.agents.runIntakeAgent

Request body

templatestring required

The identifier of the workflow template

fileUrlsstring[] required

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

Example request

{
  "template": "600b296c3e15a234ab88f884",
  "fileUrls": [
    "https://example.com/contract.pdf"
  ]
}

Response

The response of the initiated async Intake Agent run.

asyncJobIdstring required
asyncJobStatusUrlstring required

Example response

{
  "asyncJobId": "NjyiSyy7HFXFqpS23-fwp",
  "asyncJobStatusUrl": "https://ironcladapp.com/public/api/v1/intake-agent/run/NjyiSyy7HFXFqpS23-fwp"
}

Changes