philidor-io

philidor-io Access API

The Access API from philidor-io — 2 operation(s) for access.

Documentation GitHub OpenAPI

Operations 2

GET /v1/me The calling key, its limits and today’s usage #

GET /v1/access/families Gated data families and the plan that unlocks each #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/philidor-io:philidor-io-access-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Philidor Io Access API
  version: 1.2.0
  description: 'Operations tagged Access across 2 of this provider''s published API definitions: philidor-openapi.json, philidor-io-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.philidor.io
  description: Production
- url: http://localhost:3003
  description: Local
tags:
- name: Access
paths:
  /v1/me:
    get:
      operationId: getMe
      tags:
      - Access
      summary: The calling key, its limits and today’s usage
      description: Requires an API key. Returns the key identity (id, prefix, partner, tier), the effective rate limits, and today’s per-endpoint request counts from the usage rollup (flushed every 60 s). Never cached.
      responses:
        '200':
          description: The calling key
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      key:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            description: Key uuid; the value in audit rows and request logs.
                          prefix:
                            type: string
                            example: pk_live_0394f668
                          partner_name:
                            type: string
                          tier:
                            type: string
                            description: data | decisioning | embedded
                          created_at:
                            type: string
                          last_used_at:
                            type:
                            - string
                            - 'null'
                          org_id:
                            type:
                            - string
                            - 'null'
                        required:
                        - id
                        - prefix
                        - partner_name
                        - tier
                        - created_at
                        - last_used_at
                        - org_id
                      limits:
                        type: object
                        properties:
                          requests_per_minute:
                            type: integer
                          shared_key:
                            type: boolean
                            description: True only for a shared-key integration metered per sub-client.
                          subclient_requests_per_minute:
                            type:
                            - integer
                            - 'null'
                            description: Per-sub-client budget when shared_key is true, else null.
                        required:
                        - requests_per_minute
                        - shared_key
                        - subclient_requests_per_minute
                      usage:
                        type: object
                        properties:
                          day:
                            type: string
                            description: UTC day the per-endpoint counts cover.
                          as_of_lag_seconds:
                            type: integer
                            description: Counts are flushed every 60 s; the last minute may be missing.
                          total_count:
                            type: integer
                            description: Served requests over the key lifetime.
                          throttled_count:
                            type: integer
                            description: Requests answered 429 over the key lifetime (not in total_count).
                          endpoints:
                            type: array
                            items:
                              type: object
                              properties:
                                endpoint:
                                  type: string
                                  example: /v1/vaults/:chain/:address
                                count:
                                  type: integer
                                last_seen:
                                  type: string
                              required:
                              - endpoint
                              - count
                              - last_seen
                        required:
                        - day
                        - as_of_lag_seconds
                        - total_count
                        - throttled_count
                        - endpoints
                    required:
                    - key
                    - limits
                    - usage
                required:
                - data
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '401':
          description: No API key presented
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '403':
          description: The credential does not carry the required plan or role
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - ApiKeyAuth: []
      parameters:
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
  /v1/access/families:
    get:
      operationId: listGatedFamilyRefusals
      tags:
      - Access
      summary: Gated data families and the plan that unlocks each
      description: 'Anonymous. One row per data family an anonymous caller is not already served: the withheld family (`restricted_fields`), the lowest plan that includes it, the upgrade URL, and an x402 price that stays null until pay-per-request is live. The same objects are the `refusal` field on 401/403 responses for those families. Generated from the access grid, not hand-written per surface.'
      responses:
        '200':
          description: Gated families
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/StructuredRefusal'
                required:
                - data
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
        '429':
          description: Rate limit exceeded; retry after Retry-After seconds
          headers:
            Retry-After:
              $ref: '#/components/headers/Retry-After'
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/X-RateLimit-Reset'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
      - {}
      - ApiKeyAuth: []
      parameters:
      - name: X-Request-Id
        in: header
        required: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9_-]{1,64}$
        description: Optional correlation id, echoed unchanged when valid; otherwise a UUID is generated.
    servers:
    - url: https://api.philidor.io
      description: Production
    - url: http://localhost:3003
      description: Local
components:
  headers:
    Retry-After:
      description: Seconds to wait before retrying (429, 503, 504).
      schema:
        type: integer
        minimum: 0
    X-RateLimit-Limit:
      description: Requests allowed in the active window for this caller.
      schema:
        type: integer
    X-RateLimit-Reset:
      description: Unix timestamp (seconds) when the window resets.
      schema:
        type: integer
    X-RateLimit-Remaining:
      description: Requests remaining in the active window.
      schema:
        type: integer
    X-Request-Id:
      description: Correlation id for the request. A valid inbound X-Request-Id (1-64 word characters or dashes) is echoed; otherwise one is generated. Quote it when reporting a failure.
      schema:
        type: string
  schemas:
    StructuredRefusal:
      type: object
      properties:
        restricted_fields:
          type: array
          items:
            type: string
          description: Withheld names. A family gate lists the family.
        family:
          type: string
        required_plan:
          type:
          - string
          - 'null'
          enum:
          - Free
          - Analyst
          - Pro
          - Data
          - Decisioning
          - Embedded
          - null
          description: Lowest plan that includes the family. Null when no plan includes it yet.
        upgrade_url:
          type: string
          enum:
          - https://philidor.io/pricing
        x402_price:
          type: 'null'
          description: USD price for one x402 call. Null until pay-per-request is live.
      required:
      - restricted_fields
      - family
      - required_plan
      - upgrade_url
      - x402_price
    ErrorEnvelope:
      description: Error body. `legacy_code` is present for one compatibility release when an older endpoint previously emitted a lowercase route-specific code.
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - request_id
          properties:
            code:
              type: string
              pattern: ^[A-Z][A-Z0-9_]*$
              example: NOT_FOUND
            message:
              type: string
              example: Vault not found
            request_id:
              type: string
              description: Correlation id, also in the X-Request-Id header.
            legacy_code:
              type: string
              description: Previous lowercase code during the one-release migration window.
            pricing_url:
              type: string
              description: Present on a tier gate. Same URL as refusal.upgrade_url.
            refusal:
              description: Present on 401/403 for a gated data family (PHI-312). Same object as one row of GET /v1/access/families. x402_price is null until pay-per-request is live.
              type: object
              required:
              - restricted_fields
              - family
              - required_plan
              - upgrade_url
              - x402_price
              properties:
                restricted_fields:
                  type: array
                  items:
                    type: string
                family:
                  type: string
                required_plan:
                  type:
                  - string
                  - 'null'
                  enum:
                  - Free
                  - Analyst
                  - Pro
                  - Data
                  - Decisioning
                  - Embedded
                  - null
                upgrade_url:
                  type: string
                  example: https://philidor.io/pricing
                x402_price:
                  type: 'null'
          additionalProperties: true
  securitySchemes:
    IndexTokenAuth:
      type: http
      scheme: bearer
      description: Separate index preview/client token. Commercial API keys do not unlock private index routes.
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Philidor API key (`Authorization: Bearer pk_live_...`). Optional on public endpoints, where it raises rate limits and unlocks tiered capabilities. The administrative surfaces additionally require operator-set metadata.admin_surface=true; mutations require metadata.admin_role=admin_editor or admin_operator under the same write-role enforcement as admin sessions. A plan tier alone never grants administrative access.'
    AdminCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_admin_session
      description: Administrative session. Additionally IP-allowlisted.
    DashboardCookieAuth:
      type: apiKey
      in: cookie
      name: philidor_dashboard_session
      description: Dashboard session cookie (httpOnly).
x-refined-from:
- philidor-openapi.json
- philidor-io-openapi.json