Tinyfish Authentication

generated: '2026-07-21'
method: searched
source: openapi/tinyfish-main-openapi.json, openapi/tinyfish-search-openapi.json, openapi/tinyfish-fetch-openapi.json, openapi/tinyfish-browser-openapi.json
docs: https://docs.tinyfish.ai/authentication
summary:
  types: [apiKey]
  api_key_in: [header]
  api_key_name: X-API-Key
  oauth2_flows: []
  notes: >-
    All four public TinyFish APIs (Agent/Automation, Search, Fetch, Browser)
    authenticate with an X-API-Key request header. Keys are issued from the
    dashboard at agent.tinyfish.ai/api-keys. A separate OIDC/OAuth surface
    (issuer clerk.tinyfish.ai) exists for dashboard/user SSO login only and is
    not the programmatic API auth model.
schemes:
  - name: ApiKeyAuth
    type: apiKey
    in: header
    parameter: X-API-Key
    description: API key for authentication. Get your key from the API Keys page (agent.tinyfish.ai/api-keys).
    sources:
      - openapi/tinyfish-main-openapi.json
      - openapi/tinyfish-search-openapi.json
      - openapi/tinyfish-fetch-openapi.json
      - openapi/tinyfish-browser-openapi.json
  - name: ClerkOIDC
    type: openIdConnect
    scope: dashboard-sso-only
    openIdConnectUrl: https://clerk.tinyfish.ai/.well-known/openid-configuration
    issuer: https://clerk.tinyfish.ai
    grant_types: [authorization_code, refresh_token]
    scopes_supported: [openid, email, profile, offline_access, public_metadata, private_metadata]
    description: >-
      OIDC discovery for TinyFish dashboard/user login via Clerk. Not used for
      programmatic API calls (those use X-API-Key).
    sources:
      - well-known/tinyfish-openid-configuration.json