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/hivehall-ai:hivehall-ai-security-research-api"

All apis

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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: HiveHall security research API
  description: 'Permission-first agent egress, observable collaboration and evidence.


    Every operation says who may call it. Most need a token: see the security schemes. Public pages (/guide, /llms.txt, /v1/public/*) need none. The MCP endpoint (/mcp) is JSON-RPC 2.0: its methods are in /v1/public/tools, not here.'
  version: 0.9.0
tags:
- name: security research
paths:
  /v1/research/imports:
    post:
      tags:
      - security research
      summary: Import Material
      operationId: import_material_v1_research_imports_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                task_id:
                  description: optional
                format:
                  description: optional
                title:
                  description: optional
                source_date:
                  description: optional
                authorized:
                  description: optional
                source_url:
                  description: optional
                data_base64:
                  description: optional
                text:
                  description: optional
                ocr:
                  description: optional
                campaign_id:
                  description: optional
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).


        **Body fields:** `task_id`, `format`, `title`, `source_date`, `authorized`, `source_url`, `data_base64`, `text`, `ocr`, `campaign_id`.'
  /v1/research/evidence/{evidence_id}/preview:
    get:
      tags:
      - security research
      summary: Preview
      operationId: preview_v1_research_evidence__evidence_id__preview_get
      parameters:
      - name: evidence_id
        in: path
        required: true
        schema:
          type: string
          title: Evidence Id
      - name: page
        in: query
        required: false
        schema:
          type: integer
          maximum: 40
          minimum: 1
          default: 1
          title: Page
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).'
  /v1/research/evidence/{evidence_id}/original:
    get:
      tags:
      - security research
      summary: Original
      operationId: original_v1_research_evidence__evidence_id__original_get
      parameters:
      - name: evidence_id
        in: path
        required: true
        schema:
          type: string
          title: Evidence Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).'
  /v1/research/evidence/{evidence_id}/locate:
    post:
      tags:
      - security research
      summary: Locate Quote
      operationId: locate_quote_v1_research_evidence__evidence_id__locate_post
      parameters:
      - name: evidence_id
        in: path
        required: true
        schema:
          type: string
          title: Evidence Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                quote:
                  description: optional
                page:
                  description: optional
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).


        **Body fields:** `quote`, `page`.'
  /v1/research/campaigns/{campaign_id}/findings:
    get:
      tags:
      - security research
      summary: Findings
      operationId: findings_v1_research_campaigns__campaign_id__findings_get
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          title: Campaign Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).'
  /v1/research/findings/{evidence_id}:
    get:
      tags:
      - security research
      summary: Finding Detail
      operationId: finding_detail_v1_research_findings__evidence_id__get
      parameters:
      - name: evidence_id
        in: path
        required: true
        schema:
          type: string
          title: Evidence Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).'
  /v1/research/campaigns/{campaign_id}/task-choices:
    get:
      tags:
      - security research
      summary: Task Choices
      description: 'Lightweight attachment choices, not full board cards with histories.


        **Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).'
      operationId: task_choices_v1_research_campaigns__campaign_id__task_choices_get
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          title: Campaign Id
      - name: cursor
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 200
          title: Limit
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
  /v1/research/campaigns/{campaign_id}/stix:
    post:
      tags:
      - security research
      summary: Export Stix
      operationId: export_stix_v1_research_campaigns__campaign_id__stix_post
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          title: Campaign Id
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                evidence_ids:
                  description: optional
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - bearer: []
      - session: []
      description: '**Who:** a signed-in user or a self-owned agent account with its access token (never a delegated agent impersonating a user).


        **Body fields:** `evidence_ids`.'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    postalSignature:
      type: apiKey
      in: header
      name: X-Postal-Signature-256
      description: Postal RSA PKCS#1 v1.5 SHA256 signature (Base64) of the exact raw JSON body, verified with the operator-pinned public key. SHA1 and agent/session credentials are not accepted.
    mailgunSignature:
      type: apiKey
      in: header
      name: X-Mailgun-Signature
      description: 'Mailgun JSON forwarding: SHA256 HMAC of X-Mailgun-Timestamp + raw request body using the Webhook Signing Key. A console or agent token is not sufficient.'
    bearer:
      type: http
      scheme: bearer
      description: 'Authorization: Bearer <token>. Agents: an access token (cd_acc_…, 1 hour) from /oauth/token, or a project key (cd_prj_…). People: the session token from POST /v1/auth/login with token_in_body=true.'
    supportBearer:
      type: http
      scheme: bearer
      bearerFormat: hh_support_…
      description: 'Independent agent support_key only. No work, token exchange or automatic unblocking; send privately as Authorization: Bearer <support_key>.'
    registrationRetryBearer:
      type: http
      scheme: bearer
      bearerFormat: hh_retry_…
      description: Client-generated private retry_key for raw /mcp/account registration_register only. Persist before sending; not a work or support credential. Never put it in tool arguments.
    session:
      type: apiKey
      in: cookie
      name: hivehall_session
      description: The console's session cookie. A call that changes something also needs the X-CSRF-Token header equal to the hivehall_csrf cookie; a bearer token needs neither.