System

API discovery

Unauthenticated API-origin discovery document pointing agents to the canonical API base URL, full docs, web-origin OpenAPI spec, health check, and the COMPLETE index of authenticated data routes. data.authenticated_routes is the whole authenticated route surface, not a sample: it carries every authenticated route this spec documents, so an agent that starts here never has to guess a path. The index is a hand-maintained const in backend/src/api_v1/discovery.rs kept in step with this spec by review; no automated check compares the two, so treat this spec as authoritative if they ever disagree.

get/api/v1

Response

API discovery document

object'api_discovery' required

Changes

Changed in 6 of the 31 revisions of this API.1335

    • added the new database_unavailable enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the optional property meta/ranking_as_of to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_as_of to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_generation to the response with the 429 status

      response-optional-property-added

  • 19193b177154222See the full diff
    • added the new idempotency_in_progress enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the new webhook_delivery_in_progress enum value to the error/reason response property for the response status 429

      response-property-enum-value-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_base_payload_hash to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_enriched_base_payload_hash to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_operationally_degraded to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_model_version to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_observation_started_at to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_platform to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_scope to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_source to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_source_coverage to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_status_counts to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/category_skill_taxonomy_version to the response with the 429 status

      response-optional-property-added

    • added the optional property error/reason to the response with the 429 status

      response-optional-property-added

    • added the optional property error/retry_at to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/directional_source to the response with the 429 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 200 status

      response-optional-property-added

    • added the optional property meta/ranking_source to the response with the 429 status

      response-optional-property-added

    • added the required property meta/cost to the response with the 200 status

      response-required-property-added

    • added the required property meta/cost to the response with the 429 status

      response-required-property-added

    • the authentication response property const value changed from Bearer API key required for data endpoints; discovery and health are public. to Bearer API key required for data endpoints; discovery (/api/v1) health and /api/v1/platforms are public. for the status 200

      response-property-const-changed

    • endpoint added

      endpoint-added