Scale AI Events API

openapi: 3.2.0
info:
  title: Agentex Events API
  version: 0.1.0
tags:
- name: Events
paths:
  /events/{event_id}:
    get:
      tags:
      - Events
      summary: Get Event
      operationId: get_event_events__event_id__get
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          type: string
          title: Event Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /events:
    get:
      tags:
      - Events
      summary: List Events
      description: 'List events for a specific task and agent.


        Optionally filter for events after a specific sequence ID.

        Results are ordered by sequence_id.'
      operationId: list_events_events_get
      parameters:
      - name: last_processed_event_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Optional event ID to get events after this ID
          title: Last Processed Event Id
        description: Optional event ID to get events after this ID
      - name: limit
        in: query
        required: false
        schema:
          anyOf:
          - type: integer
            maximum: 1000
            minimum: 1
          - type: 'null'
          description: Optional limit on number of results
          title: Limit
        description: Optional limit on number of results
      - name: task_id
        in: query
        required: true
        schema:
          type: string
          description: The task ID to filter events by
          title: Task Id
        description: The task ID to filter events by
      - name: agent_id
        in: query
        required: true
        schema:
          type: string
          description: The agent ID to filter events by
          title: Agent Id
        description: The agent ID to filter events by
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Event'
                title: Response List Events Events Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MessageStyle:
      type: string
      enum:
      - static
      - active
      title: MessageStyle
    ReasoningContent:
      properties:
        type:
          type: string
          const: reasoning
          title: Type
          description: The type of the message, in this case `reasoning`.
          default: reasoning
        author:
          $ref: '#/components/schemas/MessageAuthor'
          description: The role of the messages author, in this case `system`, `user`, `assistant`, or `tool`.
        style:
          $ref: '#/components/schemas/MessageStyle'
          description: The style of the message. This is used by the client to determine how to display the message.
          default: static
        summary:
          items:
            type: string
          type: array
          title: Summary
          description: A list of short reasoning summaries
        content:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Content
          description: The reasoning content or chain-of-thought text
      type: object
      required:
      - author
      - summary
      title: ReasoningContent
    TextContent:
      properties:
        type:
          type: string
          const: text
          title: Type
          description: The type of the message, in this case `text`.
          default: text
        author:
          $ref: '#/components/schemas/MessageAuthor'
          description: The role of the messages author, in this case `system`, `user`, `assistant`, or `tool`.
        style:
          $ref: '#/components/schemas/MessageStyle'
          description: The style of the message. This is used by the client to determine how to display the message.
          default: static
        format:
          $ref: '#/components/schemas/TextFormat'
          description: The format of the message. This is used by the client to determine how to display the message.
          default: plain
        content:
          type: string
          title: Content
          description: The contents of the text message.
        attachments:
          anyOf:
          - items:
              $ref: '#/components/schemas/FileAttachment'
            type: array
          - type: 'null'
          title: Attachments
          description: Optional list of file attachments with structured metadata.
      type: object
      required:
      - author
      - content
      title: TextContent
    TaskMessageContent:
      oneOf:
      - $ref: '#/components/schemas/TextContent'
      - $ref: '#/components/schemas/ReasoningContent'
      - $ref: '#/components/schemas/DataContent'
      - $ref: '#/components/schemas/ToolRequestContent'
      - $ref: '#/components/schemas/ToolResponseContent'
      title: TaskMessageContent
      discriminator:
        propertyName: type
        mapping:
          data: '#/components/schemas/DataContent'
          reasoning: '#/components/schemas/ReasoningContent'
          text: '#/components/schemas/TextContent'
          tool_request: '#/components/schemas/ToolRequestContent'
          tool_response: '#/components/schemas/ToolResponseContent'
    Event:
      properties:
        id:
          type: string
          title: Id
          description: The UUID of the event
        sequence_id:
          type: integer
          title: Sequence Id
          description: The sequence ID of the event
        task_id:
          type: string
          title: Task Id
          description: The UUID of the task that the event belongs to
        agent_id:
          type: string
          title: Agent Id
          description: The UUID of the agent that the event belongs to
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Created At
          description: The timestamp of the event
        content:
          anyOf:
          - $ref: '#/components/schemas/TaskMessageContent'
          - type: 'null'
          description: The content of the event
      type: object
      required:
      - id
      - sequence_id
      - task_id
      - agent_id
      title: Event
    TextFormat:
      type: string
      enum:
      - markdown
      - plain
      - code
      title: TextFormat
    ToolResponseContent:
      properties:
        type:
          type: string
          const: tool_response
          title: Type
          description: The type of the message, in this case `tool_response`.
          default: tool_response
        author:
          $ref: '#/components/schemas/MessageAuthor'
          description: The role of the messages author, in this case `system`, `user`, `assistant`, or `tool`.
        style:
          $ref: '#/components/schemas/MessageStyle'
          description: The style of the message. This is used by the client to determine how to display the message.
          default: static
        tool_call_id:
          type: string
          title: Tool Call Id
          description: The ID of the tool call that is being responded to.
        name:
          type: string
          title: Name
          description: The name of the tool that is being responded to.
        content:
          title: Content
          description: The result of the tool.
        is_error:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Error
          description: Whether the tool call resulted in an error. `None` when the harness does not report a status.
      type: object
      required:
      - author
      - tool_call_id
      - name
      - content
      title: ToolResponseContent
    ToolRequestContent:
      properties:
        type:
          type: string
          const: tool_request
          title: Type
          description: The type of the message, in this case `tool_request`.
          default: tool_request
        author:
          $ref: '#/components/schemas/MessageAuthor'
          description: The role of the messages author, in this case `system`, `user`, `assistant`, or `tool`.
        style:
          $ref: '#/components/schemas/MessageStyle'
          description: The style of the message. This is used by the client to determine how to display the message.
          default: static
        tool_call_id:
          type: string
          title: Tool Call Id
          description: The ID of the tool call that is being requested.
        name:
          type: string
          title: Name
          description: The name of the tool that is being requested.
        arguments:
          additionalProperties: true
          type: object
          title: Arguments
          description: The arguments to the tool.
      type: object
      required:
      - author
      - tool_call_id
      - name
      - arguments
      title: ToolRequestContent
    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
    FileAttachment:
      properties:
        file_id:
          type: string
          title: File Id
          description: The unique ID of the attached file
        name:
          type: string
          title: Name
          description: The name of the file
        size:
          type: integer
          title: Size
          description: The size of the file in bytes
        type:
          type: string
          title: Type
          description: The MIME type or content type of the file
      type: object
      required:
      - file_id
      - name
      - size
      - type
      title: FileAttachment
      description: Represents a file attachment in messages.
    MessageAuthor:
      type: string
      enum:
      - user
      - agent
      title: MessageAuthor
    DataContent:
      properties:
        type:
          type: string
          const: data
          title: Type
          description: The type of the message, in this case `data`.
          default: data
        author:
          $ref: '#/components/schemas/MessageAuthor'
          description: The role of the messages author, in this case `system`, `user`, `assistant`, or `tool`.
        style:
          $ref: '#/components/schemas/MessageStyle'
          description: The style of the message. This is used by the client to determine how to display the message.
          default: static
        data:
          additionalProperties: true
          type: object
          title: Data
          description: The contents of the data message.
      type: object
      required:
      - author
      - data
      title: DataContent