> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Similar papers

> Find papers like this one.

```bash cURL theme={null}
curl "https://api.stophy.dev/v1/search/research/papers/W4411630045/similar?intent=evaluating+retrieval+augmented+generation&k=5" \
  -H "Authorization: Bearer $STOPHY_API_KEY"
```

```json 200 theme={null}
{
  "success": true,
  "results": [
    {
      "paperId": "W4389519118",
      "primaryId": "doi:10.18653/v1/2023.emnlp-main.495",
      "ids": {
        "openalex": "…",
        "doi": "…"
      },
      "title": "Active Retrieval Augmented Generation",
      "abstract": "Zhengbao Jiang, Frank Xu, Luyu Gao, Zhiqing Sun, Qian Liu, Jane Dwivedi-Yu, Yiming Yang, Jamie Callan, Graham Neubig.…",
      "authors": [
        "Zhengbao Jiang",
        "Frank F. Xu",
        "Luyu Gao"
      ],
      "year": 2023,
      "venue": "Conference on Empirical Methods in Natural Language Processing (EMNLP)",
      "citedByCount": 462,
      "openAccessUrl": "https://aclanthology.org/2023.emnlp-main.495.pdf",
      "score": 101772.93
    }
  ],
  "poolSize": 5,
  "truncated": false,
  "note": "Ranked by words in the intent and the seed titles; no citation signals.",
  "costUsd": 0.001,
  "requestId": "f28c8056-3ae1-4f30-8e78-11b4e4ca90eb"
}
```


## OpenAPI

````yaml api-reference/openapi.json GET /v1/search/research/papers/{id}/similar
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Each operation shows its method and its input: a JSON object body, path and
    query parameters, or a file upload.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    Text comes back whole. To get shorter responses, add
    ?maxTextLength=<characters> to the URL. Every text value longer than that is
    cut and ends with …. A screenshot is never cut, and a page whose text was
    cut has isTruncated set to true.


    The x-cost-usd response header is what the request cost in dollars. An
    operation's description gives its pricing units and add-ons. The OpenAPI
    fields x-cost-usd and x-cost-usd-max are list-price estimates, not receipts
    or spending limits. When a call starts a job, check the job result for its
    total cost.


    When a response has a cursor, send it back unchanged with the same input to
    get the next page. When it has a page, send the next page number.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/search/research/papers/{id}/similar:
    get:
      summary: Find papers like this one.
      description: >-
        Costs $0.001 per block of up to 10 returned results; no results cost
        nothing.
      operationId: researchPaperSimilar
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: intent
          in: query
          required: true
          schema:
            type: string
            minLength: 1
        - name: mode
          in: query
          required: false
          schema:
            type: string
            enum:
              - similar
        - name: k
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 40
            description: How many results to return.
        - name: anchor
          in: query
          required: false
          description: More paper ids to find papers like. Repeat it for each.
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Papers like it.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - costUsd
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        paperId:
                          type: string
                        primaryId:
                          type: string
                        ids:
                          type: object
                        title:
                          type: string
                        abstract:
                          type: string
                        authors:
                          type: array
                          items:
                            type: string
                        year:
                          type: integer
                        venue:
                          type: string
                        citedByCount:
                          type: integer
                        openAccessUrl:
                          type: string
                        score:
                          type: number
                  poolSize:
                    type: integer
                  truncated:
                    type: boolean
                  note:
                    type: string
                  creditsUsed:
                    type: integer
                  costUsd:
                    type: number
                    description: What this call cost, in dollars.
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. Retry-After says when trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
        - code
      properties:
        success:
          const: false
        error:
          type: string
          description: What went wrong and what to do next.
        code:
          type: string
          enum:
            - apiKeyRequired
            - busy
            - checkRunning
            - cliSessionCompleted
            - cliSessionExists
            - cliSessionNotFound
            - forbidden
            - freeLimit
            - insufficientCredits
            - internalError
            - inviteClaimed
            - inviteDisabled
            - inviteExpired
            - inviteUsedUp
            - invalidCliSession
            - invalidCliVerifier
            - invalidRequest
            - jobFinished
            - methodNotAllowed
            - notFound
            - payloadTooLarge
            - profileBusy
            - profileTooLarge
            - prohibitedPermission
            - promptInjectionDetected
            - rateLimited
            - sourceChanged
            - sourceRefused
            - siteNotRead
            - sourceTimeout
            - sourceUnavailable
            - unauthorized
            - unsupportedMediaType
        retryable:
          type: boolean
          description: true when trying again can help.
        retryAfterSeconds:
          type: integer
        requestId:
          type: string
        requiredCredits:
          type: number
          description: >-
            Older field: the most the call can cost, in $0.002 steps. Sent when
            the balance is too low.
        availableCredits:
          type: number
          description: 'Older field: the balance in $0.002 steps. Sent with requiredCredits.'
        requiredUsd:
          type: number
          description: >-
            The most the call can cost, in dollars. Sent when the balance is too
            low.
        availableUsd:
          type: number
          description: What is left on the account, in dollars. Sent with requiredUsd.
        billingUrl:
          type: string
          description: Where to add money. Sent with requiredUsd.
        signupUrl:
          type: string
          const: https://stophy.dev/signup
          description: >-
            Where a person gets a key. Sent with apiKeyRequired, freeLimit and
            an invalid key.
        signup:
          type: string
          const: POST https://api.stophy.dev/v1/signup
          description: >-
            The call that gets an agent a key with no human. Sent next to
            signupUrl.
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.