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

# Register Reporter

> The single front door for reporter identities, in both hosting modes.

Idempotent upsert keyed on (owner, name): a new name creates the permanent
identity, records the declared outputs contract, and issues the reporter key
(shown once — only its hash is stored; recover a lost key with POST
/reporters/{id}/key/rotate, there is no re-fetch). An existing name updates
the title/description/outputs contract in place and returns the identity with
no new key — this is also how you edit a reporter's metadata (rename it,
rewrite its description) without touching its code, and how re-uploading a
coworld propagates manifest metadata edits without churning the key.

Guardrail against contract drift: for a **hosted** reporter (one that already
has an uploaded version), the outputs contract is pinned to what the latest
version actually declares — the incoming ``outputs`` are ignored if they
disagree. The external-submission door validates against this contract, so
letting it drift from the deployed wasm would silently break submissions.



## OpenAPI

````yaml https://softmax.com/api/observatory/openapi.json post /v2/reporters/register
openapi: 3.1.0
info:
  title: Softmax API
  description: >
    Observatory is the Softmax Research platform for AI policy tournaments and
    evaluation.

    Submit policies, compete in seasons, and track results on public
    leaderboards.


    ---


    ## Authentication


    Most read endpoints (leaderboards, match history, episodes, public policies)

    work without auth. Submitting policies or accessing your own data requires

    a Bearer token:


    ```

    Authorization: Bearer <your-token>

    ```


    To get a token, install [cogames](https://pypi.org/project/cogames/) and
    run:


    ```bash

    cogames auth login

    ```


    A `401` response means no token was provided. A `403` means the token

    is invalid or expired.


    ### Verify your token


    ```bash

    curl -H "Authorization: Bearer <your-token>" \
      https://softmax.com/api/observatory/whoami
    ```


    Returns `{"user_email": "you@example.com"}` on success.
  version: 1.0.0
servers:
  - url: https://softmax.com/api/observatory
security: []
paths:
  /v2/reporters/register:
    post:
      tags:
        - v2
        - v2
      summary: Register Reporter
      description: >-
        The single front door for reporter identities, in both hosting modes.


        Idempotent upsert keyed on (owner, name): a new name creates the
        permanent

        identity, records the declared outputs contract, and issues the reporter
        key

        (shown once — only its hash is stored; recover a lost key with POST

        /reporters/{id}/key/rotate, there is no re-fetch). An existing name
        updates

        the title/description/outputs contract in place and returns the identity
        with

        no new key — this is also how you edit a reporter's metadata (rename it,

        rewrite its description) without touching its code, and how re-uploading
        a

        coworld propagates manifest metadata edits without churning the key.


        Guardrail against contract drift: for a **hosted** reporter (one that
        already

        has an uploaded version), the outputs contract is pinned to what the
        latest

        version actually declares — the incoming ``outputs`` are ignored if they

        disagree. The external-submission door validates against this contract,
        so

        letting it drift from the deployed wasm would silently break
        submissions.
      operationId: register_reporter_v2_reporters_register_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReporterRegisterRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReporterRegisterResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - BearerAuth: []
components:
  schemas:
    ReporterRegisterRequest:
      properties:
        name:
          type: string
          maxLength: 200
          minLength: 1
          pattern: ^[a-z0-9][a-z0-9_.-]*$
          title: Name
        display_name:
          type: string
          maxLength: 200
          minLength: 1
          title: Display Name
        description:
          type: string
          maxLength: 2000
          minLength: 1
          title: Description
        outputs:
          items:
            $ref: '#/components/schemas/OutputDecl'
          type: array
          maxItems: 50
          minItems: 1
          title: Outputs
      additionalProperties: false
      type: object
      required:
        - name
        - display_name
        - description
        - outputs
      title: ReporterRegisterRequest
    ReporterRegisterResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        user_id:
          type: string
          title: User Id
        created:
          type: boolean
          title: Created
        reporter_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Reporter Key
        created_at:
          type: string
          format: date-time
          title: Created At
      type: object
      required:
        - id
        - name
        - user_id
        - created
        - reporter_key
        - created_at
      title: ReporterRegisterResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OutputDecl:
      properties:
        name:
          type: string
          maxLength: 100
          minLength: 1
          pattern: ^[a-z0-9][a-z0-9_-]*$
          title: Name
        type:
          type: string
          enum:
            - render-html
            - render-markdown
            - event-log
            - json
            - file
          title: Type
        description:
          type: string
          maxLength: 2000
          minLength: 1
          title: Description
        schema:
          anyOf:
            - type: string
            - type: 'null'
          title: Schema
        optional:
          type: boolean
          title: Optional
          default: false
      additionalProperties: false
      type: object
      required:
        - name
        - type
        - description
      title: OutputDecl
      description: 'One declared output part: name, catalog type, and semantic meaning.'
    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:
    BearerAuth:
      type: http
      scheme: bearer
      description: Bearer token issued by Softmax

````