Copilot

Capture what Microsoft Copilot actually shows a user for a prompt — from the live app in a real browser — and receive it as the canonical Envelope.

Property	Value
`surfaces` value	`copilot`
Provider	Microsoft
Credits per capture	5 (charged only on success)
Alias endpoint	`POST /v1/search/copilot`

Every surface normalizes to the same Envelope, so the parser you write here handles ChatGPT, Perplexity, and the rest unchanged.

Request

Add "copilot" to surfaces on POST /v1/search. A single-surface request with no webhook runs synchronously by default (a 200 with the Envelope inline). Add ?mode=async for the durable path:

curl -X POST "https://api.aisearchapi.dev/v1/search?mode=async" \
  -H "Authorization: Bearer $AISEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "best crm for startups",
    "surfaces": ["copilot"],
    "regions": [{ "country": "US" }]
  }'

const res = await fetch('https://api.aisearchapi.dev/v1/search?mode=async', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.AISEARCH_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: 'best crm for startups',
    surfaces: ['copilot'],
    regions: [{ country: 'US' }],
  }),
});

const job = await res.json();
console.log(res.status, job); // 202

import os
import requests

res = requests.post(
    "https://api.aisearchapi.dev/v1/search",
    params={"mode": "async"},
    headers={
        "Authorization": f"Bearer {os.environ['AISEARCH_API_KEY']}",
        "Content-Type": "application/json",
    },
    json={
        "query": "best crm for startups",
        "surfaces": ["copilot"],
        "regions": [{"country": "US"}],
    },
)

print(res.status_code, res.json())  # 202

Response `202 Accepted`

{
  "jobId": "job_8t2q",
  "status": "processing",
  "children": ["job_8t2q.copilot.us"]
}

Read the dotted child id with GET /v1/jobs/job_8t2q.copilot.us to fetch its Envelope, or receive it via webhook on its terminal state.

Per-surface alias

POST /v1/search/copilot targets Copilot only — sync by default like any single-surface call — and accepts prompt (an alias of query) plus a flat country:

cURL

curl -X POST https://api.aisearchapi.dev/v1/search/copilot \
  -H "Authorization: Bearer $AISEARCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "best crm for startups",
    "country": "US"
  }'

Envelope (trimmed)

A completed Copilot child returns the canonical four-section Envelope:

{
  "job": {
    "id": "job_8t2q.copilot.us",
    "query": "best crm for startups",
    "surface": "copilot",
    "region": "us",
    "status": "completed",
    "warnings": [],
    "requestedAt": "2026-06-27T00:00:00.000Z",
    "completedAt": "2026-06-27T00:00:03.900Z"
  },
  "provenance": {
    "model": {
      "providerId": null,
      "observedLabel": "Copilot",
      "inferred": true,
      "confidence": 0.6
    },
    "webSearch": { "enabled": true, "known": true },
    "triggerState": "search",
    "persona": "anonymous_default_model",
    "loginState": "logged_out",
    "surfacePresent": true,
    "region": { "requested": "US", "effective": "US" },
    "capturedAt": "2026-06-27T00:00:03.000Z",
    "callUuid": "call_2b4d6f8a0c1e3f5a7b9d0c2e4f6a8b0d",
    "schemaVersion": "2026-06-27"
  },
  "answer": {
    "text": "For startups, the top CRMs are HubSpot, Attio and Pipedrive...",
    "markdown": "For startups, the top CRMs are **HubSpot**, **Attio** and **Pipedrive**...",
    "blocks": [
      {
        "type": "paragraph",
        "text": "For startups, the top CRMs are HubSpot, Attio and Pipedrive.",
        "referenceIds": [0, 1]
      }
    ]
  },
  "evidence": {
    "sources": [
      {
        "id": 0,
        "url": "https://www.hubspot.com",
        "title": "HubSpot",
        "role": "cited",
        "cited": true,
        "charRanges": [[31, 38]]
      },
      {
        "id": 1,
        "url": "https://attio.com",
        "title": "Attio",
        "role": "cited",
        "cited": true,
        "charRanges": [[40, 45]]
      }
    ],
    "fanOut": { "provenance": "none", "queries": [] },
    "mentions": null,
    "shopping": null,
    "ads": null
  }
}

answer

object

answer.markdown is always populated; answer.blocks[] carry the answer as typed blocks.

provenance

object

Records how the capture ran: the observed model label, requested vs effective region, and other capture context.

If Copilot returns nothing for a prompt, the child still completes: provenance.surfacePresent is false, job.warnings carries a surface_absent warning, and answer is empty. An empty capture costs no credits.

Search reference

Full request and response schema for POST /v1/search.

The Envelope

Every field in the canonical per-surface result.

Read a job

Poll a parent or fetch a child Envelope.

Webhooks

Get each child’s Envelope pushed on its terminal state.

Endpoints

Account & discovery

Watches

By surface

Request

Response `202 Accepted`

Per-surface alias

Envelope (trimmed)

Search reference

The Envelope

Read a job

Webhooks

​Request

​Response 202 Accepted

​Per-surface alias

​Envelope (trimmed)

Search reference

The Envelope

Read a job

Webhooks

Request

Response `202 Accepted`

Per-surface alias

Envelope (trimmed)