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

# weather.forecast

> Daily weather forecast for a coordinate or QWeather location id. Returns a normalized Forecast.



## OpenAPI

````yaml api-reference/openapi/v2.yaml POST /v2/ops/weather.forecast
openapi: 3.1.0
info:
  description: >-
    Fixed, versioned, provider-independent methods over AgentKey's upstream
    catalog. Each method has a stable name, input schema and output schema; the
    server picks the upstream provider, fails over, normalizes fields and
    refunds failed attempts. Every response names the provider that served it,
    the credits charged and every attempt made.
  title: AgentKey Scenario Methods
  version: '2'
servers:
  - url: https://api.agentkey.app
security: []
paths:
  /v2/ops/weather.forecast:
    post:
      tags:
        - weather
      summary: >-
        Daily weather forecast for a coordinate or QWeather location id. Returns
        a normalized Forecast.
      description: >-
        3–30 day forecast for a point (lat / lon) or a QWeather LocationID
        (location_id). City names are not resolved — geocode first. Metric units
        (°C, mm, km/h); condition / wind texts follow lang (default Chinese).


        Fixed price: 0.1 credits per successful call, whichever provider serves
        it.
      operationId: weather_forecast
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                days:
                  default: 7
                  description: Forecast length in days (QWeather granularities).
                  enum:
                    - 3
                    - 7
                    - 10
                    - 15
                    - 30
                  type: integer
                fields:
                  $ref: '#/components/schemas/FieldsProjection'
                include_raw:
                  $ref: '#/components/schemas/IncludeRaw'
                lang:
                  description: >-
                    BCP 47 language for condition / wind texts, e.g. en,
                    zh-Hans; default is the provider's (Chinese).
                  type: string
                lat:
                  description: >-
                    Latitude in decimal degrees. Required unless location_id is
                    given.
                  maximum: 90
                  minimum: -90
                  type: number
                location_id:
                  description: >-
                    QWeather LocationID (e.g. 101010100 for Beijing) from the
                    QWeather geo API. Give either lat / lon or location_id, not
                    both.
                  type: string
                lon:
                  description: >-
                    Longitude in decimal degrees. Required unless location_id is
                    given.
                  maximum: 180
                  minimum: -180
                  type: number
                provider:
                  $ref: '#/components/schemas/ProviderShorthand'
                routing:
                  $ref: '#/components/schemas/Routing'
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForecastEnvelope'
          description: Success envelope
        '400':
          $ref: '#/components/responses/ValidationError'
        '402':
          $ref: '#/components/responses/InsufficientCredits'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          $ref: '#/components/responses/UpstreamFailed'
        '504':
          $ref: '#/components/responses/Timeout'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    FieldsProjection:
      description: >-
        Projection: keep only these dotted paths of data, e.g. ["items.id",
        "items.text"].
      items:
        type: string
      type: array
    IncludeRaw:
      default: false
      description: >-
        Attach the raw upstream payload as `raw` (not a stable contract;
        truncated above 256 KB).
      type: boolean
    ProviderShorthand:
      description: Shorthand for routing.only = [provider].
      type: string
    Routing:
      additionalProperties: false
      description: >-
        Provider routing override. order: try these providers first; only:
        restrict to these (equivalent to pinning); allow_fallbacks: false tries
        only the first eligible provider.
      properties:
        allow_fallbacks:
          default: true
          description: false = try only the first eligible provider.
          type: boolean
        only:
          description: Restrict to these providers.
          items:
            type: string
          type: array
        order:
          description: Providers to try first, in order.
          items:
            type: string
          type: array
        strategy:
          default: auto
          description: >-
            How eligible providers are ordered. auto = the method's curated
            order. fastest / stable / popular are specified but not implemented
            yet (400 until then). The price is fixed whatever the strategy;
            mutually exclusive with order.
          enum:
            - auto
          type: string
      type: object
    ForecastEnvelope:
      allOf:
        - $ref: '#/components/schemas/Envelope'
        - properties:
            data:
              $ref: '#/components/schemas/Forecast'
          type: object
      description: Success envelope whose data is a Forecast.
    Envelope:
      description: Success envelope. `data` is the method's output object.
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        credits_charged:
          description: Credits charged for this call (the method's fixed price).
          type: number
        data:
          description: Method output (typed per method).
        op:
          description: Method name.
          type: string
        op_version:
          description: Method version that served the call.
          type: integer
        provider:
          description: Provider that actually served the call.
          type: string
        raw:
          description: Upstream payload, only with include_raw=true. Not a stable contract.
        raw_truncated:
          type: boolean
        request_id:
          description: Correlation id; quote it in support requests.
          type: string
        took_ms:
          type: integer
        unsupported_fields:
          description: >-
            Output paths this provider structurally does not supply; such fields
            are null for a different reason than 'missing on this record'.
          items:
            type: string
          type: array
      required:
        - op
        - op_version
        - provider
        - request_id
        - credits_charged
        - took_ms
        - attempts
        - unsupported_fields
        - data
      type: object
    Forecast:
      additionalProperties: false
      description: A multi-day weather forecast for one location.
      properties:
        days:
          description: One entry per forecast day, in date order.
          items:
            properties:
              condition:
                description: >-
                  Daytime weather condition text in the requested language
                  (Sunny, 多云 …).
                type:
                  - string
                  - 'null'
              date:
                description: Forecast date, YYYY-MM-DD (local date of the location).
                type: string
              humidity:
                description: Relative humidity, percent.
                type:
                  - integer
                  - 'null'
              precipitation:
                description: Expected precipitation, mm.
                type:
                  - number
                  - 'null'
              precipitation_probability:
                description: Chance of precipitation, percent.
                type:
                  - integer
                  - 'null'
              sunrise:
                description: Sunrise, HH:MM local time.
                type:
                  - string
                  - 'null'
              sunset:
                description: Sunset, HH:MM local time.
                type:
                  - string
                  - 'null'
              temp_max:
                description: Maximum temperature, °C.
                type:
                  - number
                  - 'null'
              temp_min:
                description: Minimum temperature, °C.
                type:
                  - number
                  - 'null'
              wind_direction:
                description: >-
                  Daytime wind direction text in the requested language (NE, 东北风
                  …).
                type:
                  - string
                  - 'null'
              wind_speed:
                description: Daytime wind speed, km/h.
                type:
                  - number
                  - 'null'
            required:
              - date
              - temp_min
              - temp_max
              - condition
              - precipitation_probability
              - precipitation
              - humidity
              - wind_speed
              - wind_direction
              - sunrise
              - sunset
            type: object
          type: array
        location:
          description: >-
            The forecast location. lat / lon echo the request when the provider
            does not return them.
          properties:
            lat:
              description: Latitude in decimal degrees.
              type:
                - number
                - 'null'
            lon:
              description: Longitude in decimal degrees.
              type:
                - number
                - 'null'
            name:
              description: Location name when the provider reports one.
              type:
                - string
                - 'null'
          required:
            - name
            - lat
            - lon
          type: object
        updated_at:
          description: When the provider last updated the forecast, RFC 3339 UTC.
          format: date-time
          type:
            - string
            - 'null'
      required:
        - location
        - days
        - updated_at
      type: object
    ErrorEnvelope:
      properties:
        attempts:
          items:
            $ref: '#/components/schemas/Attempt'
          type: array
        code:
          type: integer
        error:
          description: Human-readable message.
          type: string
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout | insufficient_credits
            | upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        op:
          description: Method name.
          type: string
        request_id:
          description: Correlation id.
          type: string
      required:
        - error
        - code
        - error_type
      type: object
    Attempt:
      description: >-
        One upstream try. Present on success and failure so a failover is never
        invisible.
      properties:
        error_type:
          description: >-
            validation | not_found | rate_limit | timeout |
            upstream_unauthorized | upstream_unavailable | provider_error
          type: string
        provider:
          description: Provider slug.
          type: string
        refunded:
          description: true when the reservation for this attempt was refunded.
          type: boolean
        status:
          description: HTTP status AgentKey mapped this attempt to (200 on success).
          type: integer
        took_ms:
          type: integer
        tool:
          description: Registry tool name (Provider/operation) that was called.
          type: string
        upstream_status:
          description: The provider's real HTTP status; absent when nothing was received.
          type: integer
      required:
        - provider
        - tool
        - status
        - took_ms
      type: object
  responses:
    ValidationError:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Validation error (unknown field, bad cursor, bad routing)
    InsufficientCredits:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Insufficient credits
    NotFound:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Not found (method, or upstream object)
    RateLimited:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Rate limited upstream
    UpstreamFailed:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: All providers failed
    Timeout:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
      description: Timed out
  securitySchemes:
    ApiKeyAuth:
      description: AgentKey API key (ak_…).
      scheme: bearer
      type: http

````

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