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

# Search feedback

> Rate the answer of an earlier search. Send one request and get JSON back. Examples in cURL, TypeScript and Python. A failed call costs nothing.

## Price

Free.

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

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/search/8cb72541-6e23-4f56-b9eb-fa02af8943b4/feedback \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":"good"}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/search/8cb72541-6e23-4f56-b9eb-fa02af8943b4/feedback", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ rating: "good" }),
});
console.log(await response.json());
```

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

import requests

response = requests.post(
    "https://api.stophy.dev/v1/search/8cb72541-6e23-4f56-b9eb-fa02af8943b4/feedback",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={"rating": "good"},
)
print(response.json())
```

```json 200 theme={null}
{
  "success": true,
  "feedbackId": "501cf5a9-e78f-42fe-84b4-750a84a5079c",
  "creditsRefunded": 0,
  "refundedUsd": 0,
  "alreadySubmitted": false,
  "dailyCapReached": false,
  "creditsRefundedToday": 0,
  "refundedTodayUsd": 0,
  "dailyRefundCap": 50,
  "dailyRefundCapUsd": 0.1,
  "costUsd": 0,
  "creditsUsed": 0,
  "requestId": "4ac9ab2e-13c8-4c44-b1b0-89a12675b575"
}
```


## OpenAPI

````yaml api-reference/openapi.json POST /v1/search/{jobId}/feedback
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/{jobId}/feedback:
    post:
      summary: Rate the answer of an earlier search.
      description: >-
        Free. A bad rating refunds what that search cost, up to a daily cap.
        jobId is the search's requestId.
      operationId: searchFeedback
      parameters:
        - name: jobId
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                rating:
                  type: string
                  enum:
                    - good
                    - partial
                    - bad
                valuableSources:
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      url:
                        type: string
                        format: uri
                      reason:
                        type: string
                        maxLength: 1000
                    required:
                      - url
                valuableResults:
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      source:
                        type: string
                        enum:
                          - web
                          - images
                          - news
                      position:
                        type: integer
                        minimum: 1
                        maximum: 100
                      reason:
                        type: string
                        maxLength: 1000
                    required:
                      - source
                      - position
                missingContent:
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      topic:
                        type: string
                        minLength: 1
                        maxLength: 200
                    additionalProperties: {}
                querySuggestions:
                  type: string
                  maxLength: 2000
                origin:
                  default: api
                  type: string
                  maxLength: 80
                integration:
                  anyOf:
                    - type: string
                      maxLength: 80
                    - type: 'null'
              required:
                - rating
      responses:
        '200':
          description: Your feedback was saved.
          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
                  feedbackId:
                    type: string
                  creditsRefunded:
                    type: number
                  refundedUsd:
                    type: number
                    description: What was refunded, in dollars.
                  alreadySubmitted:
                    type: boolean
                  dailyCapReached:
                    type: boolean
                  creditsRefundedToday:
                    type: number
                  refundedTodayUsd:
                    type: number
                    description: What was refunded today, in dollars.
                  dailyRefundCap:
                    type: number
                  dailyRefundCapUsd:
                    type: number
                    description: The most refunded in a day, in dollars.
                  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.