> ## 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.

# Paper search

> Search research papers by title and abstract. Send one request and get JSON back. Examples in cURL, TypeScript and Python.

This also answers `GET /v1/search/research/papers`, with the same fields as query parameters.

## Price

\$0.001 for each 10 results; no results cost nothing.

See [Pricing](https://docs.stophy.dev/account/pricing.md).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/search/research/papers \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"retrieval augmented generation","k":5}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/search/research/papers", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ query: "retrieval augmented generation", k: 5 }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/search/research/papers",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={"query": "retrieval augmented generation", "k": 5},
)
print(response.json())
```

```json 200 theme={null}
{
  "success": true,
  "results": [
    {
      "paperId": "W4411630045",
      "primaryId": "doi:10.18653/v1/2024.eacl-demo.16",
      "ids": {
        "openalex": [
          "W4411630045"
        ],
        "doi": [
          "10.18653/v1/2024.eacl-demo.16"
        ]
      },
      "title": "RAGAs: Automated Evaluation of Retrieval Augmented Generation",
      "abstract": "Shahul Es, Jithin James, Luis Espinosa Anke, Steven Schockaert. Proceedings of the 18th Conference of the European…",
      "authors": [
        "Shahul Es",
        "Jithin James",
        "Luis Espinosa-Anke"
      ],
      "year": 2024,
      "citedByCount": 537,
      "openAccessUrl": "https://aclanthology.org/2024.eacl-demo.16.pdf",
      "score": 102194.48
    }
  ],
  "costUsd": 0.001,
  "creditsUsed": 1,
  "requestId": "be6c6aa2-b90a-4956-b93f-5f2080287e82"
}
```


## OpenAPI

````yaml api-reference/openapi.json POST /v1/search/research/papers
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.


    x-cost-usd is what one call costs, in dollars. Every call costs the same,
    whatever it returns, unless an operation's description says it costs per 10
    results, or per hour of audio. Then x-cost-usd is the lowest price and
    x-cost-usd-max the most one call can cost. Where an operation takes limit,
    send it to return fewer results and pay for fewer.


    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:
    post:
      summary: Search research papers by title and abstract.
      description: Costs $0.001 for each 10 results; no results cost nothing.
      operationId: searchResearchPapers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - query
              properties:
                query:
                  type: string
                  minLength: 1
                k:
                  type: integer
                  minimum: 1
                  maximum: 500
                  default: 40
                  description: How many results to return.
                authors:
                  type: string
                  description: Only papers with an author whose name has this.
                from:
                  type: string
                  format: date
                to:
                  type: string
                  format: date
                sort:
                  type: string
                  enum:
                    - relevance
                    - date_desc
                  default: relevance
      responses:
        '200':
          description: The results.
          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
                  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.