Happyrobot

Happyrobot Adversarial Suites API

The Adversarial Suites API from Happyrobot — 8 operation(s) for adversarial suites.

GitHub OpenAPI

Operations 11

GET /nodes/{node_id}/adversarial-suites List adversarial suites for a node
POST /nodes/{node_id}/adversarial-suites Create an adversarial suite for a node
GET /adversarial-suites/{suite_id} Get an adversarial suite by ID
PATCH /adversarial-suites/{suite_id} Update an adversarial suite
DELETE /adversarial-suites/{suite_id} Delete an adversarial suite
POST /adversarial-suites/{suite_id}/generate Generate adversarial suite tests
POST /adversarial-suites/{suite_id}/generate-graph Generate adversarial suite workflow graph
POST /adversarial-suites/{suite_id}/run Run an adversarial suite
GET /adversarial-suites/{suite_id}/runs List adversarial suite runs
GET /adversarial-suites/runs/{suite_run_id} Get adversarial suite run by ID
GET /adversarial-suites/runs/{suite_run_id}/test-runs List test runs in a suite run

Documentation

📖
Documentation
https://docs.happyrobot.ai/api-reference
📖
APIReference
https://docs.happyrobot.ai/api-reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/authentication/happyrobot-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/openapi/happyrobot-adversarial-suites-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/conventions/happyrobot-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/errors/happyrobot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/data-model/happyrobot-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/asyncapi/happyrobot-events.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/agentic-access/happyrobot-agentic-access.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/lifecycle/happyrobot-lifecycle.yml

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/happyrobot-adversarial-suites-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

happyrobot-adversarial-suites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Happyrobot Public Adversarial Suites API
  description: Public API endpoints for Happyrobot
  version: 0.1.1
servers:
- url: https://platform.happyrobot.ai/api/v2
security:
- bearerAuth: []
tags:
- name: Adversarial Suites
paths:
  /nodes/{node_id}/adversarial-suites:
    get:
      summary: List adversarial suites for a node
      tags:
      - Adversarial Suites
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: query
        name: version_id
        required: false
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: node_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        org_id:
                          type: string
                        workflow_id:
                          type: string
                        agent_node_id:
                          type: string
                        agent_node_persistent_id:
                          type: string
                        folder_id:
                          type:
                          - string
                          - 'null'
                        name:
                          type: string
                        is_deleted:
                          type: boolean
                        adversarial_model:
                          type: string
                        timeout_seconds:
                          type: number
                        generation_prompt:
                          type: string
                        generation_count:
                          type: number
                        generation_status:
                          type: string
                        generation_error:
                          type:
                          - string
                          - 'null'
                        scope_mode:
                          type: string
                          enum:
                          - all
                          - by_category
                        scoped_categories:
                          type:
                          - array
                          - 'null'
                          items:
                            type: string
                            enum:
                            - notes
                            - style
                            - contradiction
                            - tool
                            - sequential
                        created_by:
                          type:
                          - string
                          - 'null'
                        created_at:
                          type: string
                        updated_at:
                          type: string
                      required:
                      - id
                      - org_id
                      - workflow_id
                      - agent_node_id
                      - agent_node_persistent_id
                      - name
                      - is_deleted
                      - adversarial_model
                      - timeout_seconds
                      - generation_prompt
                      - generation_count
                      - generation_status
                      - scope_mode
                      - scoped_categories
                      - created_by
                      - created_at
                      - updated_at
                      additionalProperties: false
                  folders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                      required:
                      - id
                      - name
                      additionalProperties: false
                required:
                - data
                - folders
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
    post:
      summary: Create an adversarial suite for a node
      tags:
      - Adversarial Suites
      description: Create a suite. The generation_prompt drives AI auto-generation of individual tests.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                generation_prompt:
                  type: string
                  minLength: 1
                adversarial_model:
                  type: string
                timeout_seconds:
                  type: integer
                  maximum: 9007199254740991
                generation_count:
                  type: integer
                  maximum: 9007199254740991
                scope_mode:
                  type: string
                  enum:
                  - all
                  - by_category
                scoped_categories:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                    - notes
                    - style
                    - tool
                    - sequential
              required:
              - name
              - generation_prompt
        required: true
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: node_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  suite:
                    type: object
                    properties:
                      id:
                        type: string
                      org_id:
                        type: string
                      workflow_id:
                        type: string
                      agent_node_id:
                        type: string
                      agent_node_persistent_id:
                        type: string
                      folder_id:
                        type:
                        - string
                        - 'null'
                      name:
                        type: string
                      is_deleted:
                        type: boolean
                      adversarial_model:
                        type: string
                      timeout_seconds:
                        type: number
                      generation_prompt:
                        type: string
                      generation_count:
                        type: number
                      generation_status:
                        type: string
                      generation_error:
                        type:
                        - string
                        - 'null'
                      scope_mode:
                        type: string
                        enum:
                        - all
                        - by_category
                      scoped_categories:
                        type:
                        - array
                        - 'null'
                        items:
                          type: string
                          enum:
                          - notes
                          - style
                          - contradiction
                          - tool
                          - sequential
                      created_by:
                        type:
                        - string
                        - 'null'
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - org_id
                    - workflow_id
                    - agent_node_id
                    - agent_node_persistent_id
                    - name
                    - is_deleted
                    - adversarial_model
                    - timeout_seconds
                    - generation_prompt
                    - generation_count
                    - generation_status
                    - scope_mode
                    - scoped_categories
                    - created_by
                    - created_at
                    - updated_at
                    additionalProperties: false
                required:
                - suite
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /adversarial-suites/{suite_id}:
    get:
      summary: Get an adversarial suite by ID
      tags:
      - Adversarial Suites
      description: Returns the suite and the mermaid workflow graph if already generated.
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: suite_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  suite:
                    type: object
                    properties:
                      id:
                        type: string
                      org_id:
                        type: string
                      workflow_id:
                        type: string
                      agent_node_id:
                        type: string
                      agent_node_persistent_id:
                        type: string
                      folder_id:
                        type:
                        - string
                        - 'null'
                      name:
                        type: string
                      is_deleted:
                        type: boolean
                      adversarial_model:
                        type: string
                      timeout_seconds:
                        type: number
                      generation_prompt:
                        type: string
                      generation_count:
                        type: number
                      generation_status:
                        type: string
                      generation_error:
                        type:
                        - string
                        - 'null'
                      scope_mode:
                        type: string
                        enum:
                        - all
                        - by_category
                      scoped_categories:
                        type:
                        - array
                        - 'null'
                        items:
                          type: string
                          enum:
                          - notes
                          - style
                          - contradiction
                          - tool
                          - sequential
                      created_by:
                        type:
                        - string
                        - 'null'
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - org_id
                    - workflow_id
                    - agent_node_id
                    - agent_node_persistent_id
                    - name
                    - is_deleted
                    - adversarial_model
                    - timeout_seconds
                    - generation_prompt
                    - generation_count
                    - generation_status
                    - scope_mode
                    - scoped_categories
                    - created_by
                    - created_at
                    - updated_at
                    additionalProperties: false
                  workflow_graph_mermaid:
                    type:
                    - string
                    - 'null'
                required:
                - suite
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
    patch:
      summary: Update an adversarial suite
      tags:
      - Adversarial Suites
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                adversarial_model:
                  type: string
                timeout_seconds:
                  type: integer
                  maximum: 9007199254740991
                generation_prompt:
                  type: string
                generation_count:
                  type: integer
                  maximum: 9007199254740991
                scope_mode:
                  type: string
                  enum:
                  - all
                  - by_category
                scoped_categories:
                  minItems: 1
                  type: array
                  items:
                    type: string
                    enum:
                    - notes
                    - style
                    - tool
                    - sequential
                folder_id:
                  type:
                  - string
                  - 'null'
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: suite_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  suite:
                    type: object
                    properties:
                      id:
                        type: string
                      org_id:
                        type: string
                      workflow_id:
                        type: string
                      agent_node_id:
                        type: string
                      agent_node_persistent_id:
                        type: string
                      folder_id:
                        type:
                        - string
                        - 'null'
                      name:
                        type: string
                      is_deleted:
                        type: boolean
                      adversarial_model:
                        type: string
                      timeout_seconds:
                        type: number
                      generation_prompt:
                        type: string
                      generation_count:
                        type: number
                      generation_status:
                        type: string
                      generation_error:
                        type:
                        - string
                        - 'null'
                      scope_mode:
                        type: string
                        enum:
                        - all
                        - by_category
                      scoped_categories:
                        type:
                        - array
                        - 'null'
                        items:
                          type: string
                          enum:
                          - notes
                          - style
                          - contradiction
                          - tool
                          - sequential
                      created_by:
                        type:
                        - string
                        - 'null'
                      created_at:
                        type: string
                      updated_at:
                        type: string
                    required:
                    - id
                    - org_id
                    - workflow_id
                    - agent_node_id
                    - agent_node_persistent_id
                    - name
                    - is_deleted
                    - adversarial_model
                    - timeout_seconds
                    - generation_prompt
                    - generation_count
                    - generation_status
                    - scope_mode
                    - scoped_categories
                    - created_by
                    - created_at
                    - updated_at
                    additionalProperties: false
                required:
                - suite
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
    delete:
      summary: Delete an adversarial suite
      tags:
      - Adversarial Suites
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: suite_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
                    enum:
                    - true
                required:
                - ok
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /adversarial-suites/{suite_id}/generate:
    post:
      summary: Generate adversarial suite tests
      tags:
      - Adversarial Suites
      description: Auto-generate individual adversarial tests from the suite's generation_prompt using AI.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                version_id:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                variables:
                  type: object
                  additionalProperties: {}
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: suite_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - in_progress
                required:
                - status
                additionalProperties: false
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  message:
                    type: string
                  statusCode:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  details: {}
                required:
                - error
                additionalProperties: false
  /adversarial-suites/{suite_id}/generate-graph:
    post:
      summary: Generate adversarial suite workflow graph
      tags:
      - Adversarial Suites
      description: Generate a mermaid workflow graph visualizing the test paths in this suite.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                version_id:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
              required:
              - version_id
        required: true
      parameters:
      - schema:
          type: string
          format: uuid
          pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        in: path
        name: suite_id
        required: true
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                  error:
                    type: string
                required:
                - status
                additionalProperties: false
        '401':
          description: Defa

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/happyrobot/refs/heads/main/openapi/happyrobot-adversarial-suites-api-openapi.yml