Apinoa Docs

Answer

Ask Copilot a question and get its answer, with citations and sources.

View raw .mdx
POST /v1/copilot/answer

Send the inputs as a JSON body. An answer takes seconds: allow up to 120 seconds.

Request

curl -X POST "https://gateway.apinoa.com/v1/copilot/answer" \
  -H "x-api-key: $APINOA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"prompt": "What are the best running shoes for beginners?", "country": "US"}'

Parameters

ParameterTypeRequiredNotes
promptstringyesThe question, as a person would type it.
countrystringThe market the answer is asked from, as an ISO 3166 country code. Each engine's page lists its countries.
includeenum listpage: also return the answer as a self-contained HTML page, in page.

The same parameters, and every response type, are in the OpenAPI document.

Response

Returns Answer in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "success": true,
  "data": {
    "engine": "copilot",
    "outcome": "answered",
    "prompt": "What are the best running shoes for beginners?",
    "askedAt": "2026-11-08T00:11:17.564Z",
    "country": "US",
    "language": "en-US",
    "title": "Best Running Shoes for Beginners in 2026",
    "blocks": [
      {
        "type": "paragraph",
        "markdown": "The **ASICS Novablast 6** is the strongest all‑around beginner pick th…"
      },
      {
        "type": "heading",
        "level": 3,
        "markdown": "✅ Top Overall Pick"
      },
      {
        "type": "paragraph",
        "markdown": "**ASICS Novablast 6** — Best beginner shoe overall"
      },
      {
        "type": "list",
        "ordered": false,
        "items": [
          {
            "markdown": "**Why it works:** Outstanding cushioning that protects your legs as yo…",
            "depth": 0
          }
        ]
      }
    ],
    "text": "The ASICS Novablast 6 is the strongest all‑around beginner pick thanks…",
    "markdown": "The **ASICS Novablast 6** is the strongest all‑around beginner pick th…",
    "citations": [
      {
        "start": 197,
        "end": 243,
        "sources": [
          1
        ]
      }
    ],
    "sources": [
      {
        "url": "https://runrepeat.com/guides/best-for-beginners-running-shoes",
        "title": "7 Best Running Shoes For Beginners in 2026 - RunRepeat",
        "site": "RunRepeat",
        "favicon": "https://th.bing.com/th/id/ODF.ekmCiAFMQY-67T3t-jB_1w?w=16&h=16&c=10&pid=genserp&rm=2",
        "snippet": "The 7 best running shoes for beginners based on extensive wear and lab…",
        "cited": true,
        "ext": {
          "displayUrl": "https://runrepeat.com › guides › best-for-beginners-running-shoes"
        }
      },
      {
        "url": "https://www.rtings.com/running-shoes/reviews/best/beginners",
        "title": "The 5 Best Running Shoes For Beginners of 2026 - RTINGS.com",
        "site": "RTINGS.com",
        "favicon": "https://th.bing.com/th/id/ODF.JG-7jC49BJkulfbWgwcl8g?w=16&h=16&c=10&pid=genserp&rm=2",
        "snippet": "We've tested over 310 running shoes, and these are our picks for the b…",
        "cited": true,
        "ext": {
          "displayUrl": "https://www.rtings.com › running-shoes › reviews › best › beginners"
        }
      }
    ],
    "mentions": [],
    "cards": [],
    "suggestions": [],
    "ext": {
      "model": "Gpt5Mini"
    }
  }
}

Errors

StatusCodeMeaning
400INVALID_PARAMSA parameter is missing, unknown or out of range, or the engine does not take it. The message names it.
401UNAUTHORIZEDThe x-api-key header is missing, or the key is revoked or unknown.
402INSUFFICIENT_BALANCEThe balance does not cover this call. Top up in the dashboard.
429MARKETPLACE_SATURATEDToo many concurrent calls. Retry after the Retry-After seconds.
502UPSTREAM_ERRORThe engine answered with something unusable. Retry with backoff.
502UPSTREAM_TIMEOUTThe engine did not answer in time. Retry.
503SERVICE_UNAVAILABLEA temporary failure. Retry with backoff.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.0012 per call. List price; the rate steps down above 1,000 calls a day.

Notes

  • Copilot answers one question at a time: ask each question in full. It takes no conversation and no photos.
  • Copilot answers in the language of the prompt.
  • ext.model names the model Copilot says answered.

On this page