Hypotize Projects API

openapi: 3.2.0
info:
  title: Hypotize Projects API
  version: 1.0.0
  summary: Growth experiments for agents and automations.
  description: 'Read and write the growth experiments of your Hypotize projects: ideas, tests, outcomes and learnings.


    Authenticate with a personal API key (Settings, API keys) sent as `Authorization: Bearer hyp_...`. A Read only key can call the GET endpoints; a Read and write key can also call the others.


    Errors use real HTTP status codes and one body shape: `{ "error": { "code", "message" } }`, sometimes with extra fields such as `required_roles` or the import row that failed.


    - 400 INVALID_REQUEST, INVALID_JSON, INVALID_CURSOR, INVALID_IDEMPOTENCY_KEY and the lifecycle codes (EXPERIMENT_NOT_READY, OUTCOME_REQUIRED...)

    - 401 UNAUTHORIZED: missing, invalid, revoked or expired API key

    - 403 FORBIDDEN (the key''s access level is too low) or INSUFFICIENT_ROLE (the project role is too low, with required_roles)

    - 404 NOT_FOUND

    - 409 STALE_EXPERIMENT (expected_updated_at is not the current updated_at) or IDEMPOTENCY_KEY_REUSED

    - 429 RATE_LIMITED: 300 requests a minute per key, 500 written rows every 5 minutes


    Writes accept an `Idempotency-Key` header: a retry with the same key and body within 24 hours returns the first response, with the header `Idempotent-Replayed: true`.


    Lists are paginated with `cursor`: pass `next_cursor` from the previous page until it is null.


    The same operations are available to AI agents on the MCP server at https://api.hypotize.ai/mcp.'
  contact:
    name: Hypotize
    url: https://hypotize.ai
    email: hello@hypotize.ai
  termsOfService: https://hypotize.ai/terms
servers:
- url: https://api.hypotize.ai/v1
security:
- apiKey: []
tags:
- name: Projects
  description: Projects you can access.
paths:
  /projects:
    get:
      operationId: listProjects
      summary: List projects
      description: Projects the API key's user can access, across workspaces, with the user's role and permissions.
      tags:
      - Projects
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 2048
      - name: limit
        in: query
        required: false
        schema:
          default: 20
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
  /projects/{project_id}:
    get:
      operationId: getProject
      summary: Get a project
      description: One project with its framework, settings and the user's role.
      tags:
      - Projects
      parameters:
      - name: project_id
        in: path
        required: true
        description: Project ID, from GET /projects.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '403':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
              examples:
              - NOT_FOUND
            message:
              type: string
          additionalProperties: true
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: hyp_ API key
      description: Personal API key from Settings, API keys.
externalDocs:
  description: Hypotize
  url: https://hypotize.ai/?utm_source=openapi&utm_medium=api