nowyourlink-com Ask API

The Ask API from nowyourlink-com — 1 operation(s) for ask.

Operations 2

GET /ask Look up public Spotlights or documentation with a bounded English query #
POST /ask Look up public content using NLWeb v0.55 JSON input #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nowyourlink-com:nowyourlink-com-ask-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nowyourlink-com-ask-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nowyourlink Com Ask API
  version: 1.0.0
  description: 'Operations tagged Ask across 2 of this provider''s published API definitions: nowyourlink-com-openapi.json, nowyourlink-com-preview-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://nowyourlink.com
- url: https://preview.nowyourlink.com
security: []
tags:
- name: Ask
paths:
  /ask:
    get:
      operationId: askPublicSpotlights
      summary: Look up public Spotlights or documentation with a bounded English query
      description: Deterministic read-only retrieval, not generated advice. No account access, bidding, payments or conversational state.
      security: []
      parameters:
      - name: query
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 500
          pattern: \S
          examples:
          - current spotlight
          - API documentation
      - name: mode
        in: query
        schema:
          type: string
          enum:
          - list
          default: list
      - name: streaming
        in: query
        schema:
          type: boolean
          default: false
        description: true enables finite SSE; false returns JSON.
      responses:
        '200':
          description: Bounded public retrieval. Streaming returns start, indexed result and complete SSE events, then closes.
          headers:
            RateLimit-Policy:
              description: 'IETF draft structured field: 120-token capacity, replenished at 2 tokens per second; no fixed window.'
              schema:
                type: string
              example: '"agent";q=120;nyl-refill=2'
            RateLimit:
              description: Actual remaining tokens after this request; shared per trusted client IP across public agent endpoints.
              schema:
                type: string
              example: '"agent";r=119'
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - results
                properties:
                  _meta:
                    type: object
                    required:
                    - version
                    - response_type
                    - response_format
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: answer
                      response_format:
                        const: conversational_search
                  results:
                    type: array
                    maxItems: 20
                    items:
                      type: object
                      properties:
                        '@type':
                          const: CreativeWork
                        url:
                          type: string
                          format: uri
                        name:
                          type: string
                        text:
                          type: string
                        description:
                          type: string
                        datePublished:
                          type: string
                          format: date
                        additionalType:
                          type: string
            text/event-stream:
              schema:
                type: string
              example: 'event: start

                data: {"_meta":{"version":"0.55","response_type":"answer","response_format":"conversational_search","mode":"list","site":"https://nowyourlink.com"},"streaming":true}


                event: complete

                data: {"_meta":{"version":"0.55"}}


                '
        '400':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '404':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '413':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '429':
          description: Shared public token bucket exhausted. Wait Retry-After seconds before retrying.
          headers:
            RateLimit-Policy:
              description: 'IETF draft structured field: 120-token capacity, replenished at 2 tokens per second; no fixed window.'
              schema:
                type: string
              example: '"agent";q=120;nyl-refill=2'
            RateLimit:
              description: Actual remaining tokens after this request; shared per trusted client IP across public agent endpoints.
              schema:
                type: string
              example: '"agent";r=119'
            Retry-After:
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                type: object
                required:
                - type
                - title
                - status
                - detail
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
                  docs:
                    type: string
                    format: uri
        '503':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
      tags:
      - Ask
    post:
      operationId: askPublicSpotlightsPost
      summary: Look up public content using NLWeb v0.55 JSON input
      description: Anonymous read-only retrieval. Request body is limited to 4096 UTF-8 bytes. Only list mode is supported. Legacy top-level mode and streaming are accepted; prefer options take precedence.
      security: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - query
              properties:
                query:
                  oneOf:
                  - type: string
                    minLength: 1
                    maxLength: 500
                    pattern: \S
                    examples:
                    - current spotlight
                    - API documentation
                  - type: object
                    required:
                    - text
                    properties:
                      text:
                        type: string
                        minLength: 1
                        maxLength: 500
                        pattern: \S
                        examples:
                        - current spotlight
                        - API documentation
                mode:
                  type: string
                  enum:
                  - list
                  description: Legacy option; prefer.mode takes precedence.
                streaming:
                  type: boolean
                  description: Legacy option; prefer.streaming takes precedence.
                prefer:
                  type: object
                  properties:
                    mode:
                      type: string
                      enum:
                      - list
                    streaming:
                      type: boolean
                      default: false
                    response_format:
                      type: string
                      enum:
                      - conversational_search
            example:
              query:
                text: API documentation
              prefer:
                mode: list
                streaming: false
      responses:
        '200':
          description: Bounded public retrieval. Streaming returns start, indexed result and complete SSE events, then closes.
          headers:
            RateLimit-Policy:
              description: 'IETF draft structured field: 120-token capacity, replenished at 2 tokens per second; no fixed window.'
              schema:
                type: string
              example: '"agent";q=120;nyl-refill=2'
            RateLimit:
              description: Actual remaining tokens after this request; shared per trusted client IP across public agent endpoints.
              schema:
                type: string
              example: '"agent";r=119'
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - results
                properties:
                  _meta:
                    type: object
                    required:
                    - version
                    - response_type
                    - response_format
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: answer
                      response_format:
                        const: conversational_search
                  results:
                    type: array
                    maxItems: 20
                    items:
                      type: object
                      properties:
                        '@type':
                          const: CreativeWork
                        url:
                          type: string
                          format: uri
                        name:
                          type: string
                        text:
                          type: string
                        description:
                          type: string
                        datePublished:
                          type: string
                          format: date
                        additionalType:
                          type: string
            text/event-stream:
              schema:
                type: string
              example: 'event: start

                data: {"_meta":{"version":"0.55","response_type":"answer","response_format":"conversational_search","mode":"list","site":"https://nowyourlink.com"},"streaming":true}


                event: complete

                data: {"_meta":{"version":"0.55"}}


                '
        '400':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '404':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '413':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
        '429':
          description: Shared public token bucket exhausted. Wait Retry-After seconds before retrying.
          headers:
            RateLimit-Policy:
              description: 'IETF draft structured field: 120-token capacity, replenished at 2 tokens per second; no fixed window.'
              schema:
                type: string
              example: '"agent";q=120;nyl-refill=2'
            RateLimit:
              description: Actual remaining tokens after this request; shared per trusted client IP across public agent endpoints.
              schema:
                type: string
              example: '"agent";r=119'
            Retry-After:
              schema:
                type: integer
                minimum: 1
          content:
            application/problem+json:
              schema:
                type: object
                required:
                - type
                - title
                - status
                - detail
                properties:
                  type:
                    type: string
                  title:
                    type: string
                  status:
                    type: integer
                  detail:
                    type: string
                  docs:
                    type: string
                    format: uri
        '503':
          description: Invalid request, byte limit exceeded, or unavailable public content. Errors remain JSON even when streaming was requested.
          content:
            application/json:
              schema:
                type: object
                required:
                - _meta
                - error
                properties:
                  _meta:
                    type: object
                    properties:
                      version:
                        const: '0.55'
                      response_type:
                        const: failure
                  error:
                    type: object
                    required:
                    - code
                    - message
                    properties:
                      code:
                        type: integer
                      message:
                        type: string
      tags:
      - Ask
    servers:
    - url: https://nowyourlink.com
components:
  securitySchemes:
    affiliateSession:
      type: apiKey
      in: cookie
      name: nyl_sess
      description: Signed-in user session. State changes require the website Origin. Preview uses nyl_sess_preview.
    agentOAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://api.nowyourlink.com/oauth/authorize
          tokenUrl: https://api.nowyourlink.com/oauth/token
          refreshUrl: https://api.nowyourlink.com/oauth/token
          scopes:
            account:read: Read account, settings and eligibility
            account:write: Update eligible company details and contact preferences
            reports:read: Read your campaign reports and Spotlight performance
            bids:read: Read own bids
            bids:write: Place and raise bids within the mandate
            creatives:read: Read own creatives
            creatives:write: Upload and submit creatives
            invoices:read: Read invoices
            billing:read: Read your saved payment methods
            billing:write: Manage your saved payment methods and billing portal
            security:read: Read your registered passkeys
            security:write: Remove your registered passkeys
            privacy:write: Request data export or account erasure
            connections:read: Read your authorized agent connections
            connections:write: Revoke your authorized agent connections
            affiliate:read: Read own partner statistics, referral links and payouts
            affiliate:write: Configure own callback and request commission payouts
x-refined-from:
- nowyourlink-com-openapi.json
- nowyourlink-com-preview-openapi.json