typesearch-ai Contents API

openapi: 3.2.0
info:
  title: Typesearch Ai Contents API
  version: 1.0.0
  description: 'Operations tagged Contents across 3 of this provider''s published API definitions: api.typesearch.ai.v1.openapi.json, typesearch-ai-api-v1-openapi.json, typesearch-ai-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.typesearch.ai
security:
- bearer: []
- apiKey: []
tags:
- name: Contents
paths:
  /v1/contents:
    post:
      summary: Get metadata and short excerpts for up to 10 URLs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentsRequest'
      responses:
        '200':
          description: One entry per URL, each with its own status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentsResponse'
        '402':
          description: 'Payment required: `insufficient_credits` (no credit left), `spend_limit_reached` (the key hit its monthly limit) or `budget_too_small`.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        default:
          description: 'Error (RFC 9457). In English unless the request sends `Accept-Language: es`.'
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      tags:
      - Contents
      operationId: postV1Contents
      x-operation-id-source: derived
    servers:
    - url: https://api.typesearch.ai
components:
  schemas:
    ContentsResponse:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          const: contents
        results:
          type: array
          items:
            type: object
            properties:
              url:
                type: string
              status:
                type: string
                enum:
                - ok
                - error
              error:
                anyOf:
                - type: object
                  properties:
                    code:
                      type: string
                    message:
                      type: string
                  required:
                  - code
                  - message
                  additionalProperties: false
                - type: 'null'
              title:
                type:
                - string
                - 'null'
              description:
                type:
                - string
                - 'null'
              published_at:
                type:
                - string
                - 'null'
              source:
                type:
                - string
                - 'null'
              excerpt:
                description: 'A very short verbatim excerpt (up to 25 words), never from the first paragraph: the one about the query if there is one. Null when the article can’t be quoted (short, paid, or the publisher asked for no snippets).'
                type:
                - string
                - 'null'
              highlights:
                type: array
                items:
                  type: string
              relevance:
                description: 'With query: probability that the article is about it.'
                type:
                - number
                - 'null'
            required:
            - url
            - status
            - error
            - title
            - description
            - published_at
            - source
            - excerpt
            - highlights
            - relevance
            additionalProperties: false
        usage:
          type: object
          properties:
            tokens:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
              description: Model tokens used by this request. 0 when it came from the cache.
            calls:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            cost_usd:
              description: 'What this request was billed, in USD: the list price of its mode (see `pricing` in GET /v1/usage), per query. 0 when it came from the cache. Null in partial results.'
              type:
              - number
              - 'null'
            duration_ms:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
          - tokens
          - calls
          - cost_usd
          - duration_ms
          additionalProperties: false
      required:
      - id
      - object
      - results
      - usage
      additionalProperties: false
    ContentsRequest:
      type: object
      properties:
        urls:
          minItems: 1
          maxItems: 10
          type: array
          items:
            type: string
            maxLength: 2000
            format: uri
        query:
          description: With a query, the model picks the excerpt about it and says how much each article covers it.
          type: string
          minLength: 2
          maxLength: 200
        highlights:
          default: true
          type: boolean
        max_tokens:
          default: null
          description: 'Cap on model tokens. If it is reached, the response comes back with incomplete: true.'
          anyOf:
          - type: integer
            minimum: 2000
            maximum: 9007199254740991
          - type: 'null'
      required:
      - urls
      additionalProperties: false
    Problem:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              message:
                type: string
            required:
            - path
            - message
            additionalProperties: false
      required:
      - type
      - title
      - status
      - detail
      - code
      - request_id
      additionalProperties: false
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
x-refined-from:
- api.typesearch.ai.v1.openapi.json
- typesearch-ai-api-v1-openapi.json
- typesearch-ai-openapi.json
x-pricing:
  currency: USD
  per_1000_requests:
    ultra: 1
    fast: 1.4
    normal: 2.2
    deep: 5.6
    similar: 2.2
    similar_deep: 4.6
    site_search: 2.4
  per_1000_pages:
    contents: 0.2
    contents_with_query: 0.4
  per_1000_urls_per_month:
    custom_index: 2
  per_1000_charts:
    query_addon: 0.5
    from_data: 0.3