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

# Identify your API key

> Returns the organization, project, and API key a request authenticates as, with the organization's plan. Free: call it to check that a key works and which project it belongs to. A missing, mistyped, revoked, or expired key returns 401 api_key_required. When the organization's access is blocked, it returns the same 402 as every other endpoint, naming the billing state and how to resolve it.



## OpenAPI

````yaml /openapi.json get /v1/me
openapi: 3.1.0
info:
  contact:
    email: api@particle.pro
    name: Particle
    url: https://particle.pro
  description: >-
    Podcast API for transcripts, mentions and sponsorship data. 140,000+
    podcasts transcribed, diarized and speaker-identified within minutes of
    airing, about 28,000 episodes a day. Search transcripts by keyword or
    meaning, track brand and company mentions with alerts, pull sponsor and
    ad-read data and rankings. REST API plus an MCP server for AI agents. Also
    company, people and topic intelligence.
  summary: >-
    Podcast API: transcripts, mentions, sponsors and rankings for 140,000+
    podcasts.
  termsOfService: https://particle.pro/legal/tos-api
  title: Particle API
  version: 0.1.0
  x-guidance: >-
    Podcast, people, company and topic intelligence. Authenticate with a pp_ API
    key (X-API-Key header) or pay per request with x402: a keyless call to a
    billable endpoint returns 402 with the payment requirements in the
    PAYMENT-REQUIRED header; sign the USDC transfer and repeat the request with
    PAYMENT-SIGNATURE. Start with GET /v1/podcasts/search?q=<show name>; the
    slugs in responses are the inputs to the other endpoints. Docs:
    https://docs.particle.pro; setup playbook:
    https://api.particle.pro/agents.md; endpoint and tool map with prices:
    https://api.particle.pro/llms.txt; credential recipe:
    https://api.particle.pro/auth.md.
  x-logo:
    url: https://particle.pro/favicon.svg
servers:
  - url: https://api.particle.pro
security:
  - ApiKeyHeader: []
  - BearerAuth: []
externalDocs:
  url: https://docs.particle.pro
paths:
  /v1/me:
    get:
      tags:
        - Account
        - tier:free
      summary: Identify your API key
      description: >-
        Returns the organization, project, and API key a request authenticates
        as, with the organization's plan. Free: call it to check that a key
        works and which project it belongs to. A missing, mistyped, revoked, or
        expired key returns 401 api_key_required. When the organization's access
        is blocked, it returns the same 402 as every other endpoint, naming the
        billing state and how to resolve it.
      operationId: get-me
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Identity'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PlatformError'
          description: Error
      x-codeSamples:
        - label: cURL
          lang: curl
          source: |-
            curl -H "X-API-Key: $PARTICLE_API_KEY" \
              "https://api.particle.pro/v1/me"
components:
  schemas:
    Identity:
      additionalProperties: false
      properties:
        api_key:
          $ref: '#/components/schemas/APIKey'
          description: >-
            The key the request authenticated with. Only its prefix is returned,
            never the full key.
        organization:
          $ref: '#/components/schemas/IdentityOrganization'
          description: The organization the key belongs to, and its plan.
        project:
          $ref: '#/components/schemas/Project'
          description: The project the key belongs to.
      required:
        - organization
        - project
        - api_key
      type: object
    PlatformError:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        error_code:
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        resolve:
          $ref: '#/components/schemas/ErrorResolve'
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    APIKey:
      additionalProperties: false
      properties:
        created_at:
          description: When the key was created
          format: date-time
          type: string
        created_by:
          $ref: '#/components/schemas/Creator'
          description: User who created the key
        expires_at:
          description: When the key expires, if set
          format: date-time
          type: string
        id:
          description: Unique identifier
          type: string
        key_prefix:
          description: Masked key prefix for identification (e.g. pp_abc12345...)
          type: string
        last_used_at:
          description: When the key was last used to authenticate a request
          format: date-time
          type: string
        name:
          description: Human-readable key name
          type: string
      required:
        - id
        - name
        - key_prefix
        - created_at
      type: object
    IdentityOrganization:
      additionalProperties: false
      properties:
        id:
          description: The organization's ID.
          type: string
        name:
          description: The organization's name.
          type: string
        plan:
          description: >-
            The organization's billing plan ID, e.g. business or enterprise.
            Branch on this rather than on plan_display_name.
          type: string
        plan_display_name:
          description: >-
            The plan's name as the dashboard shows it, ready to display. Omitted
            when it cannot be resolved.
          type: string
        subscription_status:
          description: >-
            ACTIVE when the subscription is in good standing. PAST_DUE when a
            payment failed and is being retried: requests are still served, but
            the payment method needs updating. CANCELED when the subscription
            has been canceled and access ends with the current billing period.
          type: string
      required:
        - id
        - name
        - plan
        - subscription_status
      type: object
    Project:
      additionalProperties: false
      properties:
        created_at:
          description: When the project was created
          format: date-time
          type: string
        description:
          description: Project description
          type: string
        id:
          description: Unique identifier
          type: string
        name:
          description: Project display name
          type: string
        slug:
          description: URL-safe project slug, unique within the organization
          type: string
        updated_at:
          description: When the project was last updated
          format: date-time
          type: string
      required:
        - id
        - name
        - slug
        - created_at
        - updated_at
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    ErrorResolve:
      additionalProperties: false
      properties:
        action:
          type: string
        endpoint:
          type: string
        message:
          type: string
        method:
          type: string
        url:
          type: string
      required:
        - message
      type: object
    Creator:
      additionalProperties: false
      properties:
        id:
          description: Creator's user ID
          type: string
        name:
          description: Creator's display name
          type: string
      required:
        - id
        - name
      type: object
  securitySchemes:
    ApiKeyHeader:
      description: Pass your API key in the X-API-Key header (recommended).
      in: header
      name: X-API-Key
      type: apiKey
    BearerAuth:
      description: Pass your API key as a Bearer token in the Authorization header.
      scheme: bearer
      type: http

````

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