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

# Send feedback

> Rate the answer of an earlier call.

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/feedback \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rating":"good","endpoint":"scrape","jobId":"ac28ed59-d0d8-4639-92e1-e1b0db5e9abb"}'
```

```json 200 theme={null}
{
  "success": true,
  "feedbackId": "843bf8c5-55cc-4998-8092-5a44cd36acf7",
  "creditsRefunded": 0,
  "refundedUsd": 0,
  "alreadySubmitted": false,
  "dailyCapReached": false,
  "creditsRefundedToday": 0,
  "refundedTodayUsd": 0,
  "dailyRefundCap": 50,
  "dailyRefundCapUsd": 0.1,
  "costUsd": 0,
  "requestId": "ddd15360-f240-433e-9c39-10d925e72cfc"
}
```


## OpenAPI

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


    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/feedback:
    post:
      summary: Rate the answer of an earlier call.
      description: >-
        Free. A bad rating refunds what that call cost, up to a daily cap. Send
        the call's requestId as jobId.
      operationId: feedback
      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'
                endpoint:
                  type: string
                  enum:
                    - search
                    - scrape
                    - parse
                    - map
                jobId:
                  type: string
                  pattern: ^[A-Za-z0-9_-]{1,100}$
                issues:
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    maxLength: 80
                    pattern: ^[a-z0-9][a-z0-9_-]*$
                tags:
                  maxItems: 20
                  type: array
                  items:
                    type: string
                    maxLength: 80
                    pattern: ^[a-z0-9][a-z0-9_-]*$
                note:
                  type: string
                  maxLength: 4000
                url:
                  type: string
                  format: uri
                pageNumbers:
                  maxItems: 100
                  type: array
                  items:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                metadata:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
              required:
                - rating
                - jobId
      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.