Inform API Reference

{
  "disposition": "deferred",
  "invocationId": "01KKJBKW08AB4A423HPZ37R1Z2",
  "nodeId": "4dbbcf35-3501-4618-ab95-847fcb6e77df",
  "memoryId": "95374e59-ba3d-4f86-adcf-3d69c00d459c",
  "pollUrl": "nodes/4dbbcf35-.../chit/01KKJBKW08AB4A423HPZ37R1Z2",
  "status": "queued"
}

curl -X POST https://my-node.interlocute.ai/inform \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "Our return policy allows returns within 30 days of purchase. Items must be unopened and in original packaging.",
    "title": "Return Policy"
  }'

curl -X POST https://my-node.interlocute.ai/inform/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "title=Q1 Sales Report" \
  -F "mode=comprehend" \
  -F "instructions=Extract revenue figures and regional breakdowns." \
  -F "file=@report.pdf;type=application/pdf"

curl -X POST https://my-node.interlocute.ai/inform/upload \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "title=Onboarding Pack" \
  -F "mode=comprehend" \
  -F "tags=onboarding,hr" \
  -F "file1=@handbook.pdf;type=application/pdf" \
  -F "file2=@org-chart.png;type=image/png"

curl -X POST https://my-node.interlocute.ai/inform \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Q1 Sales Report",
    "mode": "comprehend",
    "instructions": "Extract revenue figures and regional breakdowns.",
    "attachments": [{
      "name": "report.pdf",
      "contentType": "application/pdf",
      "url": "https://example.com/files/q1-report.pdf"
    }]
  }'

{
  "title": "Store Floor Plan",
  "attachments": [{
    "name": "floorplan.png",
    "contentType": "image/png",
    "url": "https://mybucket.s3.amazonaws.com/floorplan.png?X-Amz-Signature=..."
  }]
}

curl -X POST https://my-node.interlocute.ai/inform \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "... long product specification document ...",
    "title": "Product Specs v2.4",
    "mode": "comprehend",
    "instructions": "Focus on dimensions, weight limits, and safety certifications. Ignore marketing copy.",
    "tags": ["product", "specs", "v2.4"]
  }'

{
  "content": "Context: these are our updated pricing tiers effective March 2026.",
  "title": "Pricing Update March 2026",
  "mode": "comprehend",
  "instructions": "Merge the text context with the spreadsheet data into a single pricing reference.",
  "attachments": [{
    "name": "pricing.xlsx",
    "contentType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
    "url": "https://sharepoint.example.com/sites/ops/pricing-march-2026.xlsx"
  }]
}

const res = await fetch(
  `https://my-node.interlocute.ai/inform`,
  {
    method: "POST",
    headers: {
      "Authorization": `Bearer ${apiKey}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "Architecture Diagram",
      attachments: [{
        name: "arch.png",
        contentType: "image/png",
        url: "https://cdn.example.com/arch-diagram.png",
      }],
    }),
  }
);
const { invocationId, pollUrl } = await res.json();

async function informWithFile(nodeId, apiKey, file) {
  const buffer = await file.arrayBuffer();
  const base64 = btoa(String.fromCharCode(...new Uint8Array(buffer)));
  const dataUrl = `data:${file.type};base64,${base64}`;

  const res = await fetch(
    `https://my-node.interlocute.ai/inform`,
    {
      method: "POST",
      headers: {
        "Authorization": `Bearer ${apiKey}`,
        "Content-Type": "application/json",
      },
      body: JSON.stringify({
        title: file.name,
        mode: "comprehend",
        attachments: [{
          name: file.name,
          contentType: file.type,
          dataUrl,
          sizeBytes: file.size,
        }],
      }),
    }
  );

  const { invocationId, pollUrl } = await res.json();
  return invocationId;
}

var payload = new
{
    title = "Q1 Report",
    mode = "comprehend",
    instructions = "Summarize revenue by region.",
    attachments = new[]
    {
        new
        {
            name = "report.pdf",
            contentType = "application/pdf",
            url = "https://storage.example.com/reports/q1-2026.pdf",
        }
    }
};

var response = await httpClient.PostAsJsonAsync(
    "https://my-node.interlocute.ai/inform", payload);
var result = await response.Content
    .ReadFromJsonAsync<JsonElement>();

var invocationId = result.GetProperty("invocationId").GetString();
Console.WriteLine($"Poll: https://my-node.interlocute.ai/chit/{invocationId}");

curl https://my-node.interlocute.ai/chit/01KKJBKW08AB4A423HPZ37R1Z2 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "invocationId": "01KKJBKW08AB4A423HPZ37R1Z2",
  "status": "completed",
  "durationMs": 8500,
  "outputs": [
    {
      "kind": "artifact",
      "outputId": "artifact-001",
      "threadId": "f8a6dcda-...",
      "metadata": { "artifactType": "informed" }
    },
    {
      "kind": "assistantMessage",
      "outputId": "msg-002",
      "threadId": "f8a6dcda-...",
      "content": "## Summary\nThe Q1 report shows revenue of $4.2M..."
    },
    {
      "kind": "extractionRecord",
      "outputId": "extraction-0",
      "metadata": {
        "fileName": "report.pdf",
        "contentType": "application/pdf",
        "extractionKind": "Document",
        "profile": "TextAndLanguage",
        "extractedCharCount": "20678",
        "sizeBytes": "6286344",
        "durationMs": "3100"
      }
    },
    {
      "kind": "extractionRecord",
      "outputId": "extraction-1",
      "metadata": {
        "fileName": "org-chart.png",
        "contentType": "image/png",
        "extractionKind": "Image",
        "profile": "FullIntelligence",
        "extractedCharCount": "240",
        "sizeBytes": "524288",
        "durationMs": "1200"
      }
    }
  ]
}