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/roark:roark-me-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: Roark Analytics Me API
  description: The Roark Analytics API gives you access to the same API that powers the award winning Roark Analytics platform.
  version: 1.0.0
servers:
- description: Production
  url: https://api.roark.ai
security:
- Bearer: []
tags:
- name: Me
paths:
  /v1/me:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MeResponse'
                required:
                - data
          description: The current credential
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1Me
      tags:
      - Me
      summary: Describe the current credential
      description: Returns the scope of the credential making the request, the organization it acts in, its default project (if any) and the permissions it was granted. Works for both project-scoped API keys and user-scoped credentials from the CLI or an MCP connector.
  /v1/me/api-keys:
    get:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MeApiKeyListResponse'
                required:
                - data
          description: Your personal credentials
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: getV1MeApi-keys
      tags:
      - Me
      summary: List your personal credentials
      description: 'Returns the credentials that act as you: the ones created in the dashboard, from `roark auth login`, and MCP connectors. Requires a personal credential; a project API key is refused. Defaults to ACTIVE, pass ?status=REVOKED to see revoked ones. The key value itself is never returned.'
      parameters:
      - in: query
        name: status
        schema:
          type: string
          enum:
          - ACTIVE
          - REVOKED
          description: Filter by status. Defaults to ACTIVE.
          example: ACTIVE
    post:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreateMyApiKeyResponse'
                required:
                - data
          description: The created credential, with its key value (returned only here)
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Validation error
              example:
                type: validation
                code: invalid_parameter
                message: The request was invalid
                param: email
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: postV1MeApi-keys
      tags:
      - Me
      summary: Create a personal credential
      description: 'Mints a credential that acts as you, for a CLI or an automation. The key value is returned exactly once, in the `key` field: capture it now, it is unreadable afterwards. Requires a personal credential (a project API key is refused) and admin on the project the credential defaults to. The new credential can never exceed the one that created it: not in scope, not in permissions, and not in lifetime. Omit a field to copy it from the calling credential.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMyApiKeyInput'
  /v1/me/api-keys/{id}:
    delete:
      responses:
        '200':
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MeApiKeyRevokeResponse'
                required:
                - data
          description: The credential was revoked
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      operationId: deleteV1MeApi-keysById
      tags:
      - Me
      summary: Revoke one of your personal credentials
      description: Revokes a credential that acts as you. It stops working immediately. A credential may revoke itself, which is what `roark auth logout` does. Repeating the call is safe; an unknown id, or one belonging to someone else, answers 404.
      parameters:
      - schema:
          type: string
        in: path
        name: id
        required: true
components:
  schemas:
    MeResponse:
      type: object
      properties:
        tokenScope:
          type: string
          enum:
          - PROJECT
          - USER
        user:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            email:
              type: string
            name:
              type:
              - string
              - 'null'
          required:
          - id
          - email
          - name
        organization:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
          required:
          - id
          - name
        defaultProject:
          type:
          - object
          - 'null'
          properties:
            id:
              type: string
            name:
              type: string
            slug:
              type: string
          required:
          - id
          - name
          - slug
        grantedPermissions:
          type: array
          items:
            type: string
        scopes:
          type: array
          items:
            type: string
      required:
      - tokenScope
      - user
      - organization
      - defaultProject
      - grantedPermissions
      - scopes
      description: The credential making this request, and what it is bound to
      example:
        tokenScope: USER
        user:
          id: 0b2b1c34-5d6e-4f70-8192-a3b4c5d6e7f8
          email: ada@example.com
          name: Ada Lovelace
        organization:
          id: 9f8e7d6c-5b4a-4312-9081-7f6e5d4c3b2a
          name: Example Inc
        defaultProject:
          id: 1a2b3c4d-5e6f-4701-8293-a4b5c6d7e8f9
          name: Support Line
          slug: support-line
        grantedPermissions:
        - call:read
        - metric:read
        scopes:
        - READ
    MeApiKeyListResponse:
      type: object
      properties:
        apiKeys:
          type: array
          items:
            $ref: '#/components/schemas/MeApiKey'
      required:
      - apiKeys
      description: The credentials that act as the caller
    MeApiKey:
      type: object
      properties:
        id:
          type: string
          description: Roark ID of the credential. Pass it to DELETE to revoke.
        name:
          type: string
          description: The label chosen when it was created
        createdAt:
          type: string
          description: ISO 8601 timestamp
        lastUsedAt:
          type:
          - string
          - 'null'
          description: ISO 8601 timestamp, null if never used
        expiresAt:
          type:
          - string
          - 'null'
          description: ISO 8601 timestamp, null if it never expires
        status:
          type:
          - string
          - 'null'
          enum:
          - ACTIVE
          - REVOKED
        organizationId:
          type:
          - string
          - 'null'
          description: The organization this credential is pinned to
        defaultProjectId:
          type:
          - string
          - 'null'
          description: The project a request acts on when it sends no X-Roark-Project-Id header. Null once that project is deleted.
        scopes:
          type: array
          items:
            type: string
          description: 'Coarse tier: READ, or WRITE for read and write'
        permissions:
          type: array
          items:
            type: string
          description: Granted 'resource:action' permissions
      required:
      - id
      - name
      - createdAt
      - lastUsedAt
      - expiresAt
      - status
      - organizationId
      - defaultProjectId
      - scopes
      - permissions
      description: A credential that acts as the caller
      example:
        id: 7c6d5e4f-3a2b-4109-8765-4f3e2d1c0b9a
        name: CLI on laptop
        createdAt: '2026-09-28T11:04:00.000Z'
        lastUsedAt: '2026-10-02T08:12:31.000Z'
        expiresAt: null
        status: ACTIVE
        organizationId: 9f8e7d6c-5b4a-4312-9081-7f6e5d4c3b2a
        defaultProjectId: 1a2b3c4d-5e6f-4701-8293-a4b5c6d7e8f9
        scopes:
        - READ
        permissions:
        - call:read
        - metric:read
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
          - validation
          - authentication
          - forbidden
          - not_found
          - conflict
          - payment_required
          - rate_limit
          - internal
          description: The error type category
          examples:
          - validation
          - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
          - invalid_parameter
          - missing_required_field
          - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
          - The request was invalid
          - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
          - email
          - user_id
        details:
          description: Additional error context information
      required:
      - type
      - code
      - message
    CreateMyApiKeyResponse:
      type: object
      properties:
        id:
          type: string
          description: Roark ID of the credential. Pass it to DELETE to revoke.
        name:
          type: string
          description: The label chosen when it was created
        createdAt:
          type: string
          description: ISO 8601 timestamp
        lastUsedAt:
          type:
          - string
          - 'null'
          description: ISO 8601 timestamp, null if never used
        expiresAt:
          type:
          - string
          - 'null'
          description: ISO 8601 timestamp, null if it never expires
        status:
          type:
          - string
          - 'null'
          enum:
          - ACTIVE
          - REVOKED
        organizationId:
          type:
          - string
          - 'null'
          description: The organization this credential is pinned to
        defaultProjectId:
          type:
          - string
          - 'null'
          description: The project a request acts on when it sends no X-Roark-Project-Id header. Null once that project is deleted.
        scopes:
          type: array
          items:
            type: string
          description: 'Coarse tier: READ, or WRITE for read and write'
        permissions:
          type: array
          items:
            type: string
          description: Granted 'resource:action' permissions
        key:
          type: string
          description: The credential value. Returned only here, only once.
      required:
      - id
      - name
      - createdAt
      - lastUsedAt
      - expiresAt
      - status
      - organizationId
      - defaultProjectId
      - scopes
      - permissions
      - key
      description: The created credential, with its key
      example:
        id: 7c6d5e4f-3a2b-4109-8765-4f3e2d1c0b9a
        name: CI deploy gate
        createdAt: '2026-10-05T09:30:00.000Z'
        lastUsedAt: null
        expiresAt: null
        status: ACTIVE
        organizationId: 9f8e7d6c-5b4a-4312-9081-7f6e5d4c3b2a
        defaultProjectId: 1a2b3c4d-5e6f-4701-8293-a4b5c6d7e8f9
        scopes:
        - READ
        permissions:
        - call:read
        - metric:read
        key: roark0f1e2d3c4b5a69788796a5b4c3d2e1f09182
    MeApiKeyRevokeResponse:
      type: object
      properties:
        id:
          type: string
        deleted:
          type: boolean
          const: true
          description: Always true when the credential was revoked
      required:
      - id
      - deleted
      description: Result of revoking one of your credentials
    CreateMyApiKeyInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: A label you will recognise later. It is the only thing that tells two credentials apart in the list you revoke from.
          example: CI deploy gate
        projectId:
          type: string
          description: Project the credential assumes when a request sends no X-Roark-Project-Id header. Defaults to the calling credential's own default project. You must be an admin of whichever project is used.
        scopes:
          type: array
          items:
            type: string
            enum:
            - READ
            - WRITE
          minItems: 1
          description: 'Coarse tier. Defaults to the calling credential''s own tier, and can never exceed it: a READ credential cannot mint a WRITE one.'
          example:
          - READ
        permissions:
          type: array
          items:
            type: string
          description: 'Granular ''resource:action'' permissions. Defaults to the calling credential''s own set, and can never exceed it. A ceiling, not an entitlement: the holder still only reaches what their project membership allows.'
          example:
          - call:read
          - metric:read
        expiresAt:
          type: string
          format: date-time
          description: ISO 8601 expiry. Defaults to the calling credential's own expiry (no expiry, for a `roark auth login` credential) and may not outlive it, so a short-lived connector credential cannot mint a permanent one.
          example: '2026-12-31T23:59:59.000Z'
      required:
      - name
      description: A personal credential to mint for the caller
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT