Context.dev Agent Feedback API

openapi: 3.2.0
info:
  title: Context.dev Agent Feedback API
  description: Scrape, crawl, search, and monitor websites, and retrieve brand, people, and news data.
  version: 1.0.0
servers:
- url: https://api.context.dev/v1
tags:
- name: Agent Feedback
  description: Report API issues and documentation mismatches.
paths:
  /feedback:
    post:
      operationId: submitFeedback
      summary: Submit agent feedback
      tags:
      - Agent Feedback
      security:
      - bearerAuth: []
      description: Report an API issue or documentation mismatch, including request IDs when available.
      x-mint:
        content: <Badge color="blue">0 credits</Badge>
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                request_id:
                  type: string
                  format: uuid
                  description: The request_id of the API call the feedback is about, from its response body or X-Request-Id header.
                  example: 3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91
                category:
                  type: string
                  enum:
                  - bug
                  - docs_mismatch
                  - friction
                  - feature_gap
                  - quality_degradation
                  - other
                  description: Kind of issue.
                note:
                  type: string
                  minLength: 1
                  maxLength: 4000
                  description: What went wrong and what you expected instead.
                  example: Markdown drops the plan comparison table; expected all 4 rows.
                url:
                  type: string
                  maxLength: 2048
                  format: uri
                  description: The page the feedback is about, such as one page of a crawl or a docs page.
                  example: https://stripe.com/pricing
                tags:
                  $ref: '#/components/schemas/RequestTags'
              required:
              - category
              - note
              additionalProperties: false
            example:
              request_id: 3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91
              category: bug
              note: Markdown drops the plan comparison table; expected all 4 rows.
              url: https://stripe.com/pricing
      responses:
        '200':
          description: Feedback for this request_id was already recorded
          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'
            X-RateLimit-Mode:
              $ref: '#/components/headers/RateLimitMode'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitFeedbackResponse'
              example:
                feedback_id: fb_8f14e45fceea167a5a36dedd4bea2543
                already_submitted: true
                key_metadata:
                  credits_consumed: 0
                  credits_remaining: 9500
                request_id: b9bec613-44ed-4ee5-9d5b-3a87da5f8efe
        '201':
          description: Feedback recorded
          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'
            X-RateLimit-Mode:
              $ref: '#/components/headers/RateLimitMode'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitFeedbackResponse'
              example:
                feedback_id: fb_8f14e45fceea167a5a36dedd4bea2543
                already_submitted: false
                key_metadata:
                  credits_consumed: 0
                  credits_remaining: 9500
                request_id: b9bec613-44ed-4ee5-9d5b-3a87da5f8efe
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          description: Rate limit exceeded (10 requests per minute per organization).
          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'
            X-RateLimit-Mode:
              $ref: '#/components/headers/RateLimitMode'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Feedback could not be saved. Retry the request.
          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'
            X-RateLimit-Mode:
              $ref: '#/components/headers/RateLimitMode'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ConcurrencyErrorData:
      type: object
      properties:
        is_authenticated:
          type: boolean
          enum:
          - true
        limit_type:
          type: string
          enum:
          - concurrency
        limit:
          type: number
          minimum: 0
        remaining:
          type: number
          minimum: 0
        retry_after_seconds:
          type: number
          minimum: 0
        credits_remaining:
          type: number
          minimum: 0
        credits_charged:
          type: number
          enum:
          - 0
        should_retry:
          type: boolean
          enum:
          - false
        retry_condition:
          type: string
          enum:
          - available_concurrency
        recovery_options:
          type: array
          items:
            type: string
            enum:
            - wait_for_in_flight_requests
            - increase_concurrency_limit
        info_url:
          type: string
          enum:
          - https://context.dev/dashboard/subscription
      required:
      - is_authenticated
      - limit_type
      - limit
      - remaining
      - retry_after_seconds
      - credits_charged
      - should_retry
      - retry_condition
      - recovery_options
      - info_url
      description: Organization concurrency rejection details. Authentication is valid and no credits were charged. should_retry is false immediately; respect retry_after_seconds and wait for an in-flight request to finish or for the effective concurrency limit to increase. info_url opens subscription settings; no higher allowance is guaranteed for a particular account.
    KeyMetadata:
      type: object
      properties:
        credits_consumed:
          type: integer
          description: Credits charged for this request.
        credits_remaining:
          type: integer
          description: Credits remaining for your organization.
      required:
      - credits_consumed
      - credits_remaining
      description: Credits this request used and your remaining balance.
    BillingErrorData:
      type: object
      properties:
        is_authenticated:
          type: boolean
          enum:
          - true
        credits_remaining:
          type: number
          minimum: 0
        credits_required:
          type: number
          minimum: 0
        is_credits_required_estimated:
          type: boolean
        credits_charged:
          type: number
          minimum: 0
        should_retry:
          type: boolean
          enum:
          - false
        retry_condition:
          type: string
          enum:
          - sufficient_credits
        next_refill_at:
          type: string
          format: date-time
        next_refill_credits:
          type: number
          exclusiveMinimum: 0
        info_url:
          type: string
          enum:
          - https://context.dev/dashboard/subscription
      required:
      - is_authenticated
      - should_retry
      - retry_condition
      - info_url
      description: Credit admission or reservation failure details. credits_required is an admission estimate, not a final charge. should_retry is false for an unchanged request immediately; retry_condition requires sufficient account credits. Unknown balances, costs, and refill details are omitted. next_refill_at is an ISO 8601 UTC timestamp. Existing request_id and key_metadata remain on the error envelope.
    RequestTags:
      type: array
      items:
        type: string
        minLength: 1
        maxLength: 50
      maxItems: 20
      description: Labels for filtering usage in the dashboard.
      example:
      - production
      - team-alpha
    SubmitFeedbackResponse:
      type: object
      properties:
        feedback_id:
          type: string
          description: ID of the stored feedback.
          example: fb_8f14e45fceea167a5a36dedd4bea2543
        already_submitted:
          type: boolean
          description: True when feedback for this request_id was already recorded; the original feedback_id is returned.
        key_metadata:
          $ref: '#/components/schemas/KeyMetadata'
        request_id:
          $ref: '#/components/schemas/RequestId'
      required:
      - feedback_id
      - already_submitted
      - request_id
    ErrorResponse:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
        error_code:
          type: string
          enum:
          - PROFILE_NOT_FOUND
          - PROFILE_BUSY
          - PROFILE_SESSION_EXPIRED
          - PROFILE_REAUTHENTICATION_REQUIRED
          - PROFILE_INVALID_CREDENTIALS
          - PROFILE_MISSING_CREDENTIALS
          - PROFILE_INTERACTION_REQUIRED
          - PROFILE_AUTHENTICATION_UNKNOWN
          - PROFILE_ORIGIN_BLOCKED
          - PROFILE_INVALID_SESSION
          - PROFILE_SESSION_TOO_LARGE
          - INTERNAL_ERROR
          - VALID
          - NOT_FOUND
          - FORBIDDEN
          - USAGE_EXCEEDED
          - RATE_LIMITED
          - UNAUTHORIZED
          - DISABLED
          - PAID_PLAN_REQUIRED
          - INSUFFICIENT_PERMISSIONS
          - TIMEOUT_EXCEEDS_MAXIMUM
          - TIMEOUT_TOO_SHORT_FOR_WAIT
          - WEBSITE_ACCESS_ERROR
          - WEBSITE_BLOCKED
          - WEBSITE_NOT_FOUND
          - PDF_SKIPPED
          - PDF_IMAGES_ONLY
          - INPUT_VALIDATION_ERROR
          - ZDR_NOT_SUPPORTED
          - ZDR_NOT_ENABLED
          - FREE_EMAIL_DETECTED
          - DISPOSABLE_EMAIL_DETECTED
          - REQUEST_TIMEOUT
          - COLD_DOMAIN_TIMEOUT_TOO_LOW
          - UNSUPPORTED_CONTENT
          - CONTENT_TOO_LARGE
          - MONITOR_PAUSED
          - MONITOR_NO_WEBHOOK
          - COLLECTION_PAUSED
          - MONITOR_LIMIT_EXCEEDED
          - SEARCH_UNAVAILABLE
          - BATCH_LIMIT_EXCEEDED
          - BATCH_NOT_CANCELLABLE
          - BATCH_NOT_COMPLETED
          - IDEMPOTENCY_KEY_CONFLICT
          - DELIVERY_IN_PROGRESS
          - DELIVERY_ALREADY_DELIVERED
          - DELIVERY_EXPIRED
          - DELIVERY_CANCELLED
          description: Machine-readable error code.
        error_data:
          anyOf:
          - $ref: '#/components/schemas/BillingErrorData'
          - $ref: '#/components/schemas/ConcurrencyErrorData'
        required_permission:
          type: string
          enum:
          - logs:read
          - data:execute
          - monitors:read
          - monitors:write
          - batches:read
          - batches:write
          description: Permission required for this request when error_code is INSUFFICIENT_PERMISSIONS. Manage (write) also grants read access to the same resource group.
        key_metadata:
          $ref: '#/components/schemas/KeyMetadata'
        request_id:
          $ref: '#/components/schemas/RequestId'
      required:
      - request_id
    RequestId:
      type: string
      format: uuid
      description: Unique ID of this request, also in `X-Request-Id`. Include it when contacting support.
      example: 3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91
  headers:
    RateLimitLimit:
      description: Maximum request units per minute, or maximum concurrent requests when X-RateLimit-Mode is concurrency.
      schema:
        type: integer
        minimum: 1
    RateLimitReset:
      description: Unix timestamp in seconds when the per-minute rate limit resets. Omitted for concurrency limits.
      schema:
        type: integer
    RateLimitMode:
      description: Set to concurrency when these headers report concurrent requests. When a per-minute limit also applies, its rejections report per-minute headers without this header. New Free accounts have 2 concurrent requests and 10 requests per minute; paid plans have no per-minute limit by default. Existing and custom allowances can differ.
      schema:
        type: string
        enum:
        - concurrency
    RateLimitRemaining:
      description: Request units remaining in the current minute, or concurrent requests still available when X-RateLimit-Mode is concurrency.
      schema:
        type: integer
        minimum: 0
    RequestId:
      description: Unique ID of this request; also `request_id` in JSON bodies.
      schema:
        type: string
        format: uuid
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      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'
        X-RateLimit-Mode:
          $ref: '#/components/headers/RateLimitMode'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
      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'
        X-RateLimit-Mode:
          $ref: '#/components/headers/RateLimitMode'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Send `Authorization: Bearer <API_KEY>`. Keys have full access unless restricted to scopes.'
x-provenance:
  method: harvested
  publisher: Context.dev
  source: https://docs.context.dev/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)